CONTRIBUTING.md

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

---

Thanks for your interest in contributing to Rayniyomi!

Note: Rayniyomi is a fork of Aniyomi. For contributing to the upstream project, see Aniyomi's contributing guide.

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.

Pull Request policy

• Use ticket-based PR titles: [R123] short imperative summary
• Fill out all required sections in the PR template.
• Include verification evidence.
• For user-facing changes, include a concrete Release Notes section.

See governance docs:

• docs/governance/agent-workflow.md

• docs/governance/branch-protection.md

• docs/governance/dependency-policy.md

• docs/governance/labels-policy.md

• docs/governance/release-notes-policy.md

• ADRs: docs/adr/

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

Tools

• Android Studio
• Emulator or phone with developer options enabled to test changes.
• JDK 17 is required for building and running tests.
  • Recommended: Eclipse Temurin 17 (matches CI environment)
  • The project uses GradleJavaVersion.VERSION_17 as defined in buildSrc/src/main/kotlin/mihon/buildlogic/AndroidConfig.kt

Getting help

• For Rayniyomi-specific questions, open an issue in this repository.
• For general development questions, you may also reference Aniyomi's Discord server.

Translations

Translations are inherited from upstream Aniyomi. For translation contributions, see Aniyomi's translation guide.

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:
  • Change the app name
  • Change the app icon
  • Change or disable the app update checker
• To avoid installation conflicts:
  • Change the applicationId in build.gradle.kts
• Analytics and crash reporting are disabled in this fork (R37, R38):
  • Firebase Analytics is explicitly disabled via app/src/main/res/values/firebase_analytics_disabled.xml
  • ACRA crash reporting is disabled via app/src/main/res/values/acra_disabled.xml and commented out in app/build.gradle.kts
  • If you create your own fork and want analytics, you'll need to set up your own Firebase project and configure ACRA endpoints