|
| 1 | +# Contributing to Diffly |
| 2 | + |
| 3 | +Thank you for your interest in contributing to Diffly! We welcome all kinds of contributions, including bug reports, feature requests, documentation improvements, and code contributions. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +### 1. Fork the Repository |
| 8 | + |
| 9 | +Click the **Fork** button at the top right of this page to create your own copy of the repository. |
| 10 | + |
| 11 | +### 2. Clone Your Fork |
| 12 | + |
| 13 | +```bash |
| 14 | +git clone https://github.com/<your-username>/diffly.git |
| 15 | +cd diffly |
| 16 | +``` |
| 17 | + |
| 18 | +### 3. Create a Branch |
| 19 | + |
| 20 | +Create a new branch for your work: |
| 21 | + |
| 22 | +```bash |
| 23 | +git checkout -b your-feature-name |
| 24 | +``` |
| 25 | + |
| 26 | +### 4. Make Your Changes |
| 27 | + |
| 28 | +- Make your changes in the appropriate files. |
| 29 | +- Please include relevant tests if you are adding or changing functionality. |
| 30 | +- If updating documentation, please ensure it is clear and up to date. |
| 31 | + |
| 32 | +### 5. Run Tests |
| 33 | + |
| 34 | +Make sure all tests pass before submitting a pull request: |
| 35 | + |
| 36 | +```bash |
| 37 | +./gradlew test |
| 38 | +``` |
| 39 | + |
| 40 | +### 6. Commit and Push |
| 41 | + |
| 42 | +Commit your changes with a descriptive message: |
| 43 | + |
| 44 | +```bash |
| 45 | +git add . |
| 46 | +git commit -m "Describe your change" |
| 47 | +git push origin your-feature-name |
| 48 | +``` |
| 49 | + |
| 50 | +### 7. Open a Pull Request |
| 51 | + |
| 52 | +- Go to your fork on GitHub and open a pull request against the `main` branch of the original repository. |
| 53 | +- Please provide a clear description of your changes and reference any related issues. |
| 54 | + |
| 55 | +## Code Style |
| 56 | + |
| 57 | +- Follow Kotlin best practices. |
| 58 | +- Use descriptive variable and function names. |
| 59 | +- Write clear, concise commit messages. |
| 60 | + |
| 61 | +## Reporting Issues |
| 62 | + |
| 63 | +If you find any bugs or have feature requests, please [open an issue](https://github.com/JahidHasanCO/diffly/issues/new) and provide as much detail as possible. |
| 64 | + |
| 65 | +## Code of Conduct |
| 66 | + |
| 67 | +Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +By contributing, you agree that your contributions will be licensed under the MIT License. |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +Thank you for helping to improve Diffly! |
0 commit comments