How to Contribute

We'd love to get patches from you!

Building the Project

./gradlew build

Running the build task will make sure to compile the code, run all the tests and pass all the linters necessary.

Fork the repo
Create a feature branch
Write code and tests for your change
Make sure the code builds and all the linters pass before submitting your changes.
From your branch, make a pull request against the main repo (twitter/compose-rules)
Work with the repo maintainers to get your change reviewed
Wait for your change to get merged into the main branch in the main repo.

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Use the GitHub issue search — check if the issue has already been reported.
Check if the issue has been fixed — try to reproduce it using the latest main branch in the repository.
Isolate the problem — ideally create a reduced test case and a live example.
Please try to be as detailed as possible in your report. Include specific information about the environment - Kotlin version, Jetpack Compose version and steps required to reproduce the issue.

We expect all contributors to abide by our Code of Conduct.