Thank you for considering contributing to Cue! 🎉
We welcome contributions from the community, but we have some guidelines to keep the project high-quality and maintainable.
The main development happens in two repositories:
Please follow our Code of Conduct in all your interactions with the project.
Note: Both cue and cue-proxy repositories follow the same Code of Conduct and similar contribution guidelines.
- Check existing issues — See if someone is already working on it.
- Open an issue first for new features or significant changes.
- Small fixes (typos, docs improvements) don't need an issue, but please still mention it in your PR.
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Test your changes thoroughly
- Commit with clear messages
- Open a Pull Request
We strongly prefer contributions that:
- Fix a bug or add meaningful value
- Improve documentation or examples
- Add tests
- Improve performance or reliability
We generally do not merge:
- One-line typo fixes (unless it's a critical error)
- Purely cosmetic changes (spacing, formatting without reason)
- "Drive-by" PRs that only add your name to contributors
- Changes without explanation or context
- Clear title and description
- Reference any related issues (
Closes #123) - Pass all CI checks
- Keep changes focused (one feature/fix per PR)
- For code changes: include tests when applicable
- Improve documentation
- Report bugs with clear reproduction steps
- Suggest new features
- Help other users in Discord / GitHub issues
- Spread the word about Cue
We value quality over quantity.
A single well-thought-out contribution is much more valuable than many trivial ones. Thank you for understanding and helping keep Cue a clean, high-quality project.