Thanks for contributing to this project. Your time and input are appreciated. To get the most out of the project, please consider the following.
Please note we have a Code of Conduct, please follow it in all your interactions with the project.
Pull requests are welcome and pair well with bug reports and feature requests. Here are some tips to follow before submitting your first PR:
- Fork the repository to your own account if you haven't already.
- Develop in a fix or feature branch (
fix/describe-your-fix
,feature/describe-your-feature
), not inmain
ordevelop
. - Make your changes in your fork.
- Run tests locally using
./gradlew :ConvivaTestApp:assembleAndroidTest && ./gradlew ConvivaTestApp:connectedAndroidTest
(or use equivalent in Android Studio). - Lint your code locally using
./gradlew lint
(or use equivalent in Android Studio). - Validate your chances with the Convia Touchstone backend.
- Add an entry to the CHANGELOG.md file in the
[Unreleased]
section to describe the changes to the project. - Submit a pull request to the main repository.
The versioning scheme we use is SemVer.
All additions, modifications and fixes that are submitted will be reviewed. The project owners reserve the right to reject any pull request that does not meet our standards. We may not be able to respond to all pull requests immediately and provide no timeframes to do so.