Thanks for contributing to Realtime! We'd love to have you contribute and here’s some resources and guidance to help you get started:
Before you open a pull request, read the code of conduct and use the DEVELOPERS.md for local setup and day-to-day development.
If you found a bug, open an issue using the bug report template.
Before opening a new issue:
- Search existing issues first.
- Please use one of the issue templates and provide as much detailed context as possible.
If you want to propose a new feature, please open a GitHub Discussion first. That gives maintainers and other contributors a chance to discuss the shape of the change before you spend time building it.
All changes go through GitHub pull requests and require review.
Before opening a PR:
- Make sure there is an issue or discussion covering the work.
- Check whether someone has already opened a PR for the same problem.
- Link the related issue or discussion in your PR description.
We recommend the following practices to streamline the review process:
- Use Conventional Commits for your commit messages.
- Add or update tests to prove the change is correct, and make sure those tests and related tests pass.
- Review the code before requesting reviews, especially for AI-assisted changes.
Examples:
- Good:
fix: properly clean up subscriptions when oids changed - Good:
feat: split gen rpc pools for calls vs casts - Bad:
fix stuff - Bad:
updates
By contributing to Realtime, you agree that your contributions will be licensed under this repository's license.