From cbc01dd6f129e32c615af61675e0b4357747f29f Mon Sep 17 00:00:00 2001 From: arkon Date: Sun, 17 Jan 2021 14:39:21 -0500 Subject: [PATCH] [SKIP CI] Update fork change checklist --- CONTRIBUTING.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8cbdbed4c0..27ab585975 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,12 @@ Forks are allowed so long as they abide by [the project's LICENSE](https://githu When creating a fork, remember to: -- Change the app name to avoid confusion with the main app -- Change the package name to avoid conflicting with installations of the main app -- If you want to use Firebase, 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, replace the `ACRA_URI` endpoint in [`build.gradle.kts`](https://github.com/tachiyomiorg/tachiyomi/blob/master/app/build.gradle.kts) with your own +- 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/github/GithubUpdateChecker.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