We are happy to welcome new contributors and make the contribution process as painless as possible. If you have any questions, feel free to open an issue.
Please check the README to understand the project.
To contribute to the project, please:
- Fork this repository
- Create a branch
- Commit your changes
- Push your commits to the branch
- Submit a pull request
Any material change to the released artifact(s) should be accompanied by a CHANGELOG.md entry.
For further guidance about getting started, please refer to the related links:
- Pull Request Guidelines
- Issues Guidelines
All changes into the main branch should come from a Pull Request with a review from one of the codeowners and should generally include
an entry in CHANGELOG.md's [UNRELEASED] section (do not directly modify a version's changes, this is automatic).
Changelog entries should be organized into appropriate headings per Keep a Changelog, and follow the format:
- <contributor>: <Description of change> (#<github issue>)In order to sanitize coding standards, please follow the Kotlin Coding Conventions. Any changes should pass ktlint and detekt checks.
This project and everyone participating in it is governed by this Code of Conduct.