Contributions to the Ceeblue WebRTS Client are welcome and greatly appreciated. The project is licensed under AGPL-3.0-or-later, meaning any code you contribute will be released under the same open-source license. Please follow the guidelines below to keep the process smooth for everyone.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/CeeblueTV/wrts-client/llms.txt
Use this file to discover all available pages before exploring further.
Reporting issues
Use the GitHub issue tracker exclusively for bug reports and feature proposals — not for general usage questions (see Questions below).🐛 File a bug report
✨ Propose an enhancement
When reporting a bug, describe both the expected and actual behavior as clearly and in as much detail as possible, and provide step-by-step reproduction instructions. The more context you include, the faster the team can triage and fix the issue.
Submitting pull requests
Fork the repository
Click Fork on the wrts-client GitHub page to create a personal copy under your GitHub account.
Create a branch from dev
Always branch off
dev, not main. The main branch tracks stable releases; active development lives on dev.Make your changes and commit
Implement your changes, add tests where appropriate, and commit following the Conventional Commits format described below.
Conventional commits
The project uses Conventional Commits for automated versioning and changelog generation. Every commit message must follow the<type>: <description> format.
| Type | When to use |
|---|---|
feat | A new feature visible to end users |
fix | A bug fix |
docs | Documentation-only changes |
chore | Build system, dependency, or tooling updates |
refactor | Code changes that neither fix a bug nor add a feature |
test | Adding or updating tests |
Git hooks are automatically configured when you run
npm install. The commit-msg hook validates every commit message against Conventional Commits standards using commitlint, so malformed messages are rejected before they reach the remote.Code quality
The project enforces consistent style with Prettier and ESLint. Hooks run both tools automatically on every staged commit (pre-commit via lint-staged), so your changes are checked before they are committed. It is good practice to run the full lint suite manually before pushing to catch any issues early:
npm run eslint and npm run prettier commands if you need to auto-fix violations.
Developer’s Certificate of Origin
By making a contribution to this project, I certify that:- (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
- (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
- (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
- (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.