Contributing to SongSync

We welcome contributions from the community, whether it's reporting a bug, suggesting a feature, improving translations, or writing code.

Reporting Issues

If you've found a bug or have an idea for a new feature, the best place to let us know is on our GitHub Issues page.

Bug Reports: Please use the "Bug report" template. Provide as much detail as possible, including your device model, Android version, app version, and steps to reproduce the issue.
Feature Requests: Use the "Feature request" template to describe your idea, the problem it solves, and any alternatives you've considered.

Translations

SongSync is translated by volunteers from around the world. If you'd like to help translate the app into your language, you can do so on our Weblate project page.

Contribute translations on Weblate

Code Contributions

If you're a developer and want to contribute code, we'd love to have your help!

Development Setup

Fork the repository on GitHub.
Clone your fork to your local machine.
Set up the environment:
- You will need JDK 17 to build the project. You can configure this in Android Studio's Gradle settings.
- Open the project in the latest version of Android Studio.
Build the project: You can build a debug version of the app by running the following command in the project's root directory:
```
./gradlew assembleDebug
```

Submitting a Pull Request

Once you have made your changes:

Commit your changes with a clear and descriptive message.
Push the changes to your forked repository.
Open a Pull Request from your fork to the master branch of the main SongSync repository.
Please provide a clear description of the changes you have made in the pull request.

License

By contributing to SongSync, you agree that your contributions will be licensed under the GNU General Public License v3.0, which governs the project. You can find the full license text in the LICENSE file in the repository.