AndroidJava/Kitsune/CONTRIBUTING.md

Contributing to Kitsune

Thank you for your interest in contributing to Kitsune! Any support is greatly appreciated.

Ways to Contribute

Any contributions are welcomed, including but not limited to:

1. Code Contributions

• Check out the open issues or the project board and pick one to work on.
• See How to Contribute Code Changes to get started.
• Submit a pull request with your changes.

2. Image assets and Logos

Interested in making Kitsune more visually appealing? Don't hesitate to open a new issue or discussion if you want to create:

• custom placeholder images for media and user banners, posters or character photos
• a new app icon
• or any other design contribution.

3. Translation

• Contribute translations for different languages to make the app accessible globally.
• Copy the string.xml file to a new folder named values-LANG (e.g. values-fr for French) inside the res directory.
  • Remove strings with translatable="false".
  • Keep placeholders like %s or %d in the strings.
• Submit a pull request with your changes.

4. Documentation and Repository Files

• Improve the documentation or contribute to other repository files, like issue templates.

How to Contribute Code Changes

To start developing, follow these simple steps:

1. Set Up Your Environment:

• Make sure you have Android Studio installed.
• Familiarize yourself with Kotlin as it's the primary language used in the app.

2. Clone the Repository

3. Build and Run:

• Open the project in Android Studio.
• Build and run the app to ensure everything is set up correctly.