d1a90c0bb7
* 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> (cherry picked from commit 14ae57d78b31f0bb3b58d19c1d8cfcebcc8e2253)
71 lines
3.4 KiB
Markdown
Executable File
71 lines
3.4 KiB
Markdown
Executable File
Looking to report an issue/bug or make a feature request? Please refer to the [README file](https://github.com/tachiyomiorg/tachiyomi#issues-feature-requests-and-contributing).
|
|
|
|
---
|
|
|
|
Thanks for your interest in contributing to Tachiyomi!
|
|
|
|
|
|
# Code contributions
|
|
|
|
Pull requests are welcome!
|
|
|
|
If you're interested in taking on [an open issue](https://github.com/tachiyomiorg/tachiyomi/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/tachiyomi) for online help and to ask questions while developing.
|
|
|
|
# Translations
|
|
|
|
Translations are done externally via Weblate. See [our website](https://tachiyomi.org/docs/contribute#translation) for more details.
|
|
|
|
|
|
# Forks
|
|
|
|
Forks are allowed so long as they abide by [the project's LICENSE](https://github.com/tachiyomiorg/tachiyomi/blob/master/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/tachiyomiorg/tachiyomi/blob/master/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/tachiyomiorg/tachiyomi/blob/master/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/tachiyomiorg/tachiyomi/blob/master/app/src/standard/google-services.json) with your own
|
|
- If you want to use ACRA crash reporting, replace the `ACRA_URI` endpoint in [`build.gradle.kts`](https://github.com/tachiyomiorg/tachiyomi/blob/master/app/build.gradle.kts) with your own
|
|
|
|
|
|
### Supporting Cloud Sync - Google Drive Implementation
|
|
1. Go to [Google Cloud Console](https://console.cloud.google.com)
|
|
2. Create a new project
|
|
3. Go to API & Services -> Library -> Google Drive API and click enable
|
|
4. Go to API & Services -> Oauth consent screen
|
|
5. Create it, fill in the app name, user support email, and developer contact information
|
|
6. In the next screen, click add or remove scopes, and add the `.../auth/drive.appdata` and `.../auth/drive.file` scopes
|
|
7. Don't add any test users and go back to the dashboard
|
|
8. Click publish
|
|
9. Go to API & Services -> Credentials
|
|
10. Click Create credentials -> Oauth client ID
|
|
11. Select Android, give it a name, and set `eu.kanade.google.oauth` as the package name
|
|
12. To get the SHA-1 key, run `keytool -printcert -jarfile app-standard-universal-release.apk` on your apk, and copy the listed SHA-1
|
|
13. Expand advanced settings, and enable Custom URL scheme
|
|
14. After that just download the json, name it to `client_secrets.json` and put it in `app/src/main/assets/` |