CONTRIBUTING.md

Contributing to Habit-Maker

• Ways to contribute
• Application structure
• Code contributions
  • Kotlin
  • Code quality
• Adding translations

Ways to contribute

• Participate here and start answering questions.
• File new bug reports for issues you find.
• Add missing translations.
• Code contributions.

Application structure

• Basic Modern Android Development tech stack (Compose, Navigation, Coroutines, AndroidX)
• Guide to App Architecture, without domain layer. Basically, MVVM + Repositories for data access.

Code contributions

You can open in AndroidStudio, version 2022.3.1 or later (Giraffe).

Use Java 11+, preferably Java 17

Kotlin

This project is full Kotlin. Please do not write Java classes.

Code quality

The code must be formatted to a common standard.

To check for violations

./gradlew lintKotlin

Or just run this to fix them

./gradlew formatKotlin

Markdown and yaml files are formatted according to prettier.

You can install prettier either through the plugin, or globally using npm npm install -g prettier

To check for violations

prettier -c "*.md" "*.yml"

To fix the violations

prettier --write "*.md" "*.yml"

Adding translations

You can add translation via weblate, or add translations manually in the app/src/main/res/values-{locale}/strings.xml file.

You can open it in android studio, right click and click open translations editor or you can directly edit the files.

If you add a new locale. Also add it in locales_config.xml. Don't forget to escape ' in translations.