tachiyomi/CONTRIBUTING.md

2.2 KiB

  1. Before reporting a new issue, take a look at the FAQ, the changelog and the already opened issues.
  2. If you are unsure, ask here: Discord
  3. What is your type of issue?
  4. After following 1. and 3. you can open your issue

Source requests

Bugs

  • Include version (More > About > Version)
  • If not latest, try updating, it may have already been solved
  • Preview version is equal to the number of commits as seen in the main page
  • Include steps to reproduce (if not obvious from description)
  • Include screenshot (if needed)
  • If it could be device-dependent, try reproducing on another device (if possible)
  • For large logs use http://pastebin.com/ (or similar)
  • Don't group unrelated requests into one issue

DO: https://github.com/tachiyomiorg/tachiyomi/issues/24 https://github.com/tachiyomiorg/tachiyomi/issues/71

DON'T: https://github.com/tachiyomiorg/tachiyomi/issues/75

Feature requests

  • Write a detailed issue, explaining what it should do or how. Avoid writing just "like X app does"
  • Include screenshot (if needed)

Forks

Forks are allowed so long as they abide by the project's LICENSE.

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 with your own
  • If you want to use ACRA, replace the ACRA_URI endpoint in build.gradle.kts with your own