mihon/CONTRIBUTING.md

Looking to report an issue/bug or make a feature request? Please refer to the README file.

---

Thanks for your interest in contributing to Mihon!

Code contributions

Pull requests are welcome!

If you're interested in taking on an open issue, please comment on it so others are aware. You do not need to ask for permission nor an assignment.

Prerequisites

Before you start, please note that the ability to use following technologies is required and that existing contributors will not actively teach them to you.

• Basic Android development
• Kotlin

Tools

• Android Studio
• Emulator or phone with developer options enabled to test changes.

Linting

To auto-fix some linting errors, run the ktlintFormat Gradle task.

Getting help

• Join the Discord server for online help and to ask questions while developing.

Translations

Translations are done externally via Weblate. See our website for more details.

Forks

Forks are allowed so long as they abide by the project's LICENSE.

When creating a fork, remember to:

• To avoid confusion with the main app:
  • Change the app name
  • Change the app icon
  • Change or disable the app update checker
• To avoid installation conflicts:
  • Change the applicationId in build.gradle.kts
• To avoid having your data polluting the main app's analytics and crash report services:
  • If you want to use Firebase analytics, replace google-services.json with your own