Contribution licence
The Grantex SDKs and client packages are Apache-2.0; the server, portal and documentation are under the Orchestrum Personal Use License 1.0, under which Orchestrum Technologies LLP also licenses organisations by written agreement (see the Licence page). By submitting a contribution you agree to the contribution licence in CONTRIBUTING.md: you keep your copyright and grant Orchestrum Technologies LLP a perpetual, irrevocable licence to distribute and license the contribution on any terms, including agreements with organisations.Where to Start
Look for issues tagged
good first issue.
Development Setup
Repository Structure
PR Guidelines
- Open an issue first for anything non-trivial
- One PR per concern — don’t bundle unrelated changes
- Tests required — all new code needs tests
- Spec changes need discussion — protocol changes require a Discussion with at least 72 hours for community input
- Changelog entry — add a line to
CHANGELOG.mdunderUnreleased
Code Style
- TypeScript: ESLint + Prettier
- Python: Ruff + Black
- Commits: Conventional Commits (
feat:,fix:,docs:,spec:)
Protocol Changes (RFCs)
Changes to SPEC.md follow a lightweight RFC process:- Open a GitHub Discussion tagged
[RFC] - Describe the change, motivation, and alternatives
- 72-hour minimum comment period
- Maintainer merges or closes with reasoning
Questions?
- GitHub Discussions for design questions
- GitHub Issues for bugs and feature requests
- Discord for real-time chat