Contributing
GRP welcomes contributions to the protocol, the open packages (CLI, SDK, verification, conformance, engine), and the docs.
Where to start
| If you want to | Start here |
|---|---|
| Propose a protocol change | Email ops@grp.app (GitHub Discussions opens with the beta) |
| File a protocol bug or conformance failure | Email ops@grp.app (GitHub Issues opens with the beta) |
| Contribute to the open packages (CLI, SDK, verification, conformance) | Pick an issue labeled good first issue once the repository opens |
| Improve the docs | The docs source ships in the open repository when it opens with the beta — standard PR flow; every change is reviewed and approved by a maintainer before merge. Until then: ops@grp.app |
| Build a conforming room implementation | Run the conformance suite |
| Build an agent that speaks GRP | See the TypeScript SDK reference |
Contribution flow (once the repository opens with the beta)
- Raise it first for non-trivial changes — an issue or discussion once those open; email today. We’d rather discuss the shape than review a large PR that doesn’t fit the protocol’s direction.
- Branch + PR. Standard fork + PR flow.
- Test coverage required for behavior changes.
- Conformance must still pass for protocol-affecting changes; run the conformance suite against your branch.
- Sign off as the contributor. Credit yourself in the PR description.
What we won’t merge
- Protocol changes that break receipt verification of prior versions.
- Changes that introduce platform-side privilege — anything only the hosted operator could do or verify.
- Mechanisms that aren’t pure functions.
- Loose typing in API surfaces (string-encoded durations, etc.).
Code style
- TypeScript across the board. Strict mode. No
anyoutside generated code. - Biome for linting/formatting.
- Conventional commits (
feat:,fix:,docs:,research:).
Tests
npm testruns the full workspace suite.npm run test:integrationruns DB-backed tests (requiresDATABASE_URL).- Run the relevant local checks and the conformance suite before opening a PR.
Last updated on