tachiyomi/CONTRIBUTING.md

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.

## 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/help/contribution/#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
Remove duplicated info from CONTRIBUTING.md 2021-01-18 03:15:36 +08:00			`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).`
README, CONTRIBUTING and ISSUE_TEMPLATE, Discord (#952) * Include discord, change issue segment * Update CONTRIBUTING.md * Update ISSUE_TEMPLATE.md 2017-08-28 15:42:44 +08:00
Add list of things to change in forks to CONTRIBUTING.md 2021-01-18 03:09:42 +08:00			`---`
README, CONTRIBUTING and ISSUE_TEMPLATE, Discord (#952) * Include discord, change issue segment * Update CONTRIBUTING.md * Update ISSUE_TEMPLATE.md 2017-08-28 15:42:44 +08:00
Remove duplicated info from CONTRIBUTING.md 2021-01-18 03:15:36 +08:00			`Thanks for your interest in contributing to Tachiyomi!`
Update CONTRIBUTING.md (#684) Add catalogue redirection to tachiyomi-extensions 2017-02-13 02:31:38 +08:00

Remove duplicated info from CONTRIBUTING.md 2021-01-18 03:15:36 +08:00			`# Code contributions`
Create CONTRIBUTING.md 2016-01-31 00:44:22 +08:00
Remove duplicated info from CONTRIBUTING.md 2021-01-18 03:15:36 +08:00			`Pull requests are welcome!`
Create CONTRIBUTING.md 2016-01-31 00:44:22 +08:00
Remove duplicated info from CONTRIBUTING.md 2021-01-18 03:15:36 +08:00			`If you're interested in taking on [an open issue](https://github.com/tachiyomiorg/tachiyomi/issues), please comment on it so others are aware.`
[skip ci] add note about issue taking in contribution guide 2022-01-28 23:20:51 +08:00			`You do not need to ask for permission nor an assignment.`
Create CONTRIBUTING.md 2016-01-31 00:44:22 +08:00
Add Prerequisites and Getting help to Contributing.md (#6682) 2022-02-22 20:58:00 +08: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.`

			`## Getting help`

			`- Join [the Discord server](https://discord.gg/tachiyomi) for online help and to ask questions while developing.`
Add list of things to change in forks to CONTRIBUTING.md 2021-01-18 03:09:42 +08:00
Remove duplicated info from CONTRIBUTING.md 2021-01-18 03:15:36 +08:00			`# Translations`
Create CONTRIBUTING.md 2016-01-31 00:44:22 +08:00
Remove duplicated info from CONTRIBUTING.md 2021-01-18 03:15:36 +08:00			`Translations are done externally via Weblate. See [our website](https://tachiyomi.org/help/contribution/#translation) for more details.`
Add list of things to change in forks to CONTRIBUTING.md 2021-01-18 03:09:42 +08:00

			`# 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:`

[SKIP CI] Update fork change checklist 2021-01-18 03:39:21 +08:00			`- To avoid confusion with the main app:`
			`- Change the app name`
			`- Change the app icon`
[skip ci] docs: update app update checker link (#6619) 2022-02-10 21:51:08 +08:00			`- 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)`
[SKIP CI] Update fork change checklist 2021-01-18 03:39:21 +08:00			`- 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