Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/foedusprogramme/gramophone/llms.txt

Use this file to discover all available pages before exploring further.

Gramophone is open source and welcomes contributions of all kinds — code, bug reports, feature requests, and translations.

License

Gramophone is released under the GNU General Public License v3.0 (GPL-3.0-or-later). All contributions must be compatible with this license.

Community channels

ChannelLink
GitHub IssuesFoedusProgramme/Gramophone/issues
Telegram discussiont.me/FoedusDiscussion
Telegram announcementst.me/FoedusProgramme / t.me/AkaneDev

Security issues

For security-related or otherwise confidential reports, email nift4dev@gmail.com instead of opening a public issue.

Bug reports

Open a bug report at GitHub Issues. When filing a bug report, use the Bug report issue template ([BUG] prefix in the title) and include:
  • A clear description of the bug
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable
  • Device model, Android version, and app version
Open one issue per bug and follow the issue format. Issues that do not follow the format may be closed without further explanation.

Feature requests

Use the Feature request issue template ([FR] prefix in the title) and describe:
  • The problem your request addresses
  • The solution you would like
  • Any alternatives you have considered
Open one request per issue and follow the format.

Submitting a pull request

1

Fork the repository

Fork FoedusProgramme/Gramophone on GitHub and create a branch for your change.
2

Set up the build environment

You need the latest beta version of Android Studio and a fast network connection.
3

Initialize submodules

Gramophone includes dependencies such as media3 as git submodules. Run the following before building:
git submodule update --init --recursive
4

Configure the package type

Create a file named package.properties in the root of the repository with the following content:
releaseType=SelfBuilt
5

Build and test

Open the project in Android Studio, import your app signing key, and verify your changes build and run correctly before submitting.
6

Open a pull request

Push your branch to your fork and open a pull request against the main repository. Describe what the change does and why.

Code style

Gramophone follows standard Android and Kotlin conventions. Match the style of the surrounding code when making changes. SongSync — a related project by a Gramophone contributor for syncing lyrics.

Build docs developers (and LLMs) love