We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
We recommend using the Android Studio IDE to jumpstart your development workflow
To get started with the project
- clone this repository
- import the project into Android Studio
While developing, you can run the example app to test your changes.
- You can do this via the IDE itself using the
Run appbutton in the toolbar - You can install the debug version of the app using the gradle command:
./gradlew installDebug
Remember to add tests for your change if possible. Run the unit tests:
- Running the tests via the IDE
- via the command line
./gradlew test
We follow the conventional commits specification for our commit messages:
fix: bug fixes, e.g. fix crash due to deprecated method.feat: new features, e.g. add new method to the module.refactor: code refactor, e.g. migrate from class components to hooks.docs: changes into documentation, e.g. add usage example for the module..test: adding or updating tests, eg add integration tests using detox.chore: tooling changes, e.g. change CI config.
./gradlew test
Our pre-commit hooks verify that the linter and tests pass when committing.
Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.
When you're sending a pull request:
- Prefer small pull requests focused on one change.
- Verify that linters and tests are passing.
- Review the documentation to make sure it looks good.
- Follow the pull request template when opening a pull request.
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.