Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (46 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

75 lines (46 loc) · 1.85 KB

Contributing to Diffly

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.

How to Contribute

1. Fork the Repository

Click the Fork button at the top right of this page to create your own copy of the repository.

2. Clone Your Fork

git clone https://github.com/<your-username>/diffly.git
cd diffly

3. Create a Branch

Create a new branch for your work:

git checkout -b your-feature-name

4. Make Your Changes

  • Make your changes in the appropriate files.
  • Please include relevant tests if you are adding or changing functionality.
  • If updating documentation, please ensure it is clear and up to date.

5. Run Tests

Make sure all tests pass before submitting a pull request:

./gradlew test

6. Commit and Push

Commit your changes with a descriptive message:

git add .
git commit -m "Describe your change"
git push origin your-feature-name

7. Open a Pull Request

  • Go to your fork on GitHub and open a pull request against the main branch of the original repository.
  • Please provide a clear description of your changes and reference any related issues.

Code Style

  • Follow Kotlin best practices.
  • Use descriptive variable and function names.
  • Write clear, concise commit messages.

Reporting Issues

If you find any bugs or have feature requests, please open an issue and provide as much detail as possible.

Code of Conduct

Please note we have a Code of Conduct. By participating, you are expected to uphold this code.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for helping to improve Diffly!