mirror of
https://github.com/mihonapp/mihon.git
synced 2024-12-25 18:38:23 +01:00
14ae57d78b
* Contributing: ktLintFormat -> detekt update Contributing info to use detekt instead of ktLintFormat * Update CONTRIBUTING.md --------- Co-authored-by: AntsyLich <59261191+AntsyLich@users.noreply.github.com>
54 lines
2.2 KiB
Markdown
54 lines
2.2 KiB
Markdown
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).
|
|
|
|
---
|
|
|
|
Thanks for your interest in contributing to Mihon!
|
|
|
|
|
|
# Code contributions
|
|
|
|
Pull requests are welcome!
|
|
|
|
If you're interested in taking on [an open issue](https://github.com/mihonapp/mihon/issues), 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](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.
|
|
|
|
## Linting
|
|
|
|
Run the `detekt` gradle task. If the build fails, a report of issues can be found in `app/build/reports/detekt/`. The report is availble in several formats and details each issue that needs attention.
|
|
|
|
## Getting help
|
|
|
|
- Join [the Discord server](https://discord.gg/mihon) for online help and to ask questions while developing.
|
|
|
|
# Translations
|
|
|
|
Translations are done externally via Weblate. See [our website](https://mihon.app/docs/contribute#translation) for more details.
|
|
|
|
|
|
# Forks
|
|
|
|
Forks are allowed so long as they abide by [the project's LICENSE](https://github.com/mihonapp/mihon/blob/main/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](https://github.com/mihonapp/mihon/blob/main/app/src/main/java/eu/kanade/tachiyomi/data/updater/AppUpdateChecker.kt)
|
|
- To avoid installation conflicts:
|
|
- Change the `applicationId` in [`build.gradle.kts`](https://github.com/mihonapp/mihon/blob/main/app/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`](https://github.com/mihonapp/mihon/blob/main/app/src/standard/google-services.json) with your own
|