mirrors/aniyomi
1
0
Fork 0
mirror of https://github.com/aniyomiorg/aniyomi.git synced 2024-11-22 21:02:16 +03:00
Code Issues Projects Releases Packages Wiki Activity
aniyomi/CONTRIBUTING.md
Catting 23b8a06271
Contributing: ktLintFormat -> detekt (#1102) 
* 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)
2024-10-26 10:18:18 +02:00

2.4 KiB
Raw Blame History

Looking to report an issue/bug or make a feature request? Please refer to the README file.

Thanks for your interest in contributing to Aniyomi!

Code contributions

Pull requests are welcome!

If you're interested in taking on an open issue, 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.

Tools

  • Android 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

Translations

Translations are done externally via Weblate. See our website for more details.

Forks

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

When creating a fork, remember to:

  • To avoid confusion with the main app:
  • To avoid installation conflicts:
  • 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 with your own
    • If you want to use ACRA crash reporting, replace the ACRA_URI endpoint in build.gradle.kts with your own