Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Fork and clone the repository
- Create a new branch:
git checkout -b my-branch-name - Make your change and remember to add tests
- Build the project locally and run local tests
gradlew build test - Check and correct new possible issues with sonar
gradlew sonar
- Check the global coverage
gradlew generateMergedReport
- Push to your fork and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the [style guide][link to styleguide].
- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests.
- Write good commit messages.