Contributing

We welcome contributions. By contributing you agree to license under GPL-3.0. All code must be GPL-compatible.

Code of conduct

Be respectful and inclusive, welcome newcomers, and focus on constructive feedback.

Reporting bugs

• Check existing Issues first.
• Create an issue with clear title, description, steps to reproduce, and environment.

Suggesting features

Open an issue with the enhancement label. Describe the feature and how it fits RompMusic.

Code contributions

1. Fork the repository.
2. Create a branch: feature/your-feature-name.
3. Make changes following our coding standards. Add GPL-3.0 headers to new files.
4. Commit with clear messages, push to your fork, open a Pull Request.

Code standards

Server: PEP 8, type hints. Client: ESLint, Prettier. Website: consistent with existing style.

Requirements

• Audio changes must not break gapless playback.
• Only GPL-compatible dependencies. No telemetry or analytics.

Repository structure

rompmusic/
  rompmusic-server/   # FastAPI backend
  rompmusic-client/   # React Native + Expo client
  rompmusic-website/  # Next.js project site

See the README in each component for development setup.

Back to documentation