2024-01-15 14:31:22 -05:00
Looking to report an issue/bug or make a feature request? Please refer to the [README file ](https://github.com/mihonapp/mihon#issues-feature-requests-and-contributing ).
2017-08-28 03:42:44 -04:00
2021-01-17 14:09:42 -05:00
---
2017-08-28 03:42:44 -04:00
2024-01-15 10:57:31 -05:00
Thanks for your interest in contributing to Mihon!
2017-02-12 13:31:38 -05:00
2021-01-17 14:15:36 -05:00
# Code contributions
2016-01-30 11:44:22 -05:00
2021-01-17 14:15:36 -05:00
Pull requests are welcome!
2016-01-30 11:44:22 -05:00
2024-01-15 14:31:22 -05:00
If you're interested in taking on [an open issue ](https://github.com/mihonapp/mihon/issues ), please comment on it so others are aware.
2022-01-28 10:20:51 -05:00
You do not need to ask for permission nor an assignment.
2016-01-30 11:44:22 -05:00
2022-02-22 07:58:00 -05:00
## 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 ](https://developer.android.com/ )
- [Kotlin ](https://kotlinlang.org/ )
### Tools
- [Android Studio ](https://developer.android.com/studio )
- Emulator or phone with developer options enabled to test changes.
2023-10-14 11:09:11 -04:00
## Linting
To auto-fix some linting errors, run the `ktlintFormat` Gradle task.
2022-02-22 07:58:00 -05:00
## Getting help
2024-01-15 10:57:31 -05:00
- Join [the Discord server ](https://discord.gg/mihon ) for online help and to ask questions while developing.
2021-01-17 14:09:42 -05:00
2021-01-17 14:15:36 -05:00
# Translations
2016-01-30 11:44:22 -05:00
2024-01-15 12:39:48 -05:00
Translations are done externally via Weblate. See [our website ](https://mihon.app/docs/contribute#translation ) for more details.
2021-01-17 14:09:42 -05:00
# Forks
2024-01-15 14:36:08 -05:00
Forks are allowed so long as they abide by [the project's LICENSE ](https://github.com/mihonapp/mihon/blob/main/LICENSE ).
2021-01-17 14:09:42 -05:00
When creating a fork, remember to:
2021-01-17 14:39:21 -05:00
- To avoid confusion with the main app:
- Change the app name
- Change the app icon
2024-01-15 14:36:08 -05:00
- Change or disable the [app update checker ](https://github.com/mihonapp/mihon/blob/main/app/src/main/java/eu/kanade/tachiyomi/data/updater/AppUpdateChecker.kt )
2021-01-17 14:39:21 -05:00
- To avoid installation conflicts:
2024-01-15 14:36:08 -05:00
- Change the `applicationId` in [`build.gradle.kts` ](https://github.com/mihonapp/mihon/blob/main/app/build.gradle.kts )
2021-01-17 14:39:21 -05:00
- To avoid having your data polluting the main app's analytics and crash report services:
2024-01-15 14:36:08 -05:00
- If you want to use Firebase analytics, replace [`google-services.json` ](https://github.com/mihonapp/mihon/blob/main/app/src/standard/google-services.json ) with your own
