|
| 1 | +# Contributing to HashX |
| 2 | + |
| 3 | +Thank you for considering contributing to HashX! Your contributions help improve the project and benefit the open-source community. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +### 1. Reporting Issues |
| 8 | +- Before opening a new issue, check the [existing issues](https://github.com/ProgrammerKR/HashX/issues) to avoid duplicates. |
| 9 | +- Clearly describe the issue with steps to reproduce it. |
| 10 | +- Provide the version of HashX you are using. |
| 11 | + |
| 12 | +### 2. Submitting Feature Requests |
| 13 | +- Ensure your idea aligns with the project's goals. |
| 14 | +- Provide a clear explanation and potential use cases. |
| 15 | +- Label your request as a "Feature Request" in GitHub issues. |
| 16 | + |
| 17 | +### 3. Contributing Code |
| 18 | +#### Steps to contribute code: |
| 19 | +1. Fork the repository. |
| 20 | +2. Create a new branch (`feature-branch-name`). |
| 21 | +3. Commit your changes with a clear message. |
| 22 | +4. Push the branch to your forked repository. |
| 23 | +5. Submit a **Pull Request (PR)** to the `main` branch. |
| 24 | + |
| 25 | +#### Guidelines for code contributions: |
| 26 | +- Follow coding best practices and maintain code readability. |
| 27 | +- Ensure your changes do not break existing functionality. |
| 28 | +- Add comments where necessary. |
| 29 | +- Test your changes before submitting a PR. |
| 30 | + |
| 31 | +### 4. Writing Documentation |
| 32 | +- Improve documentation in the `README.md` or create separate guides. |
| 33 | +- Keep explanations clear and concise. |
| 34 | + |
| 35 | +### 5. Code Review Process |
| 36 | +- All PRs will be reviewed before merging. |
| 37 | +- Be open to feedback and make necessary changes. |
| 38 | +- Once approved, your code will be merged into the main branch. |
| 39 | + |
| 40 | +## Community Guidelines |
| 41 | +- Be respectful and constructive. |
| 42 | +- Follow the [Code of Conduct](CODE_OF_CONDUCT.md). |
| 43 | + |
| 44 | +We appreciate your contributions! 🚀 |
0 commit comments