Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (26 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1 KB
Raw

Contributing

Build the project

We recommend using Android Studio for building the project.

Source code formatting

  • Indents: 4 spaces
  • Kotlin: Use ktfmtFormat task in Gradle
  • XML: Default Android Studio formatter with 4 spaces

Note

To enforce formatting automatically on every commit, you can install the pre-commit hook once:

git config core.hooksPath .githooks

After that, ktfmtFormat will run automatically on every commit.

Propose a change

We follow the GitHub Flow. To submit a pull request:

  • Fork the repository.
  • Clone your fork to your local machine.
  • Create a new branch from main branch for your feature or fix.
  • Commit your changes and push the branch to your fork.
  • Open a pull request from your branch to the main branch of this repository.

Ensure your pull request includes:

  • A clear description of the problem or feature.
  • References to any related issues.
  • Documentation updates.