Contributing
Thanks for contributing. Greenlight is source-available under BUSL-1.1.
By submitting a pull request, you agree that your contribution is licensed under
the same BUSL-1.1 terms as the community edition (core/, ui/, docs-site/).
Read Licensing for self-host permissions and restrictions.
Development setup
See Local development for hybrid and full Docker details.
npm run setup # creates .env with secrets if missing; install + Postgres + migrate
npm run dev # core :8100, ui :3001, docs :3003Or run the full containerized stack (Compose maps GREENLIGHT_* from core secrets):
npm run docker:fullTests
npm test # core unit tests
cd ui && npm run buildAdd or update tests when changing behavior in core/.
Pull requests
- Fork and branch from
main - Keep changes focused
- Put community features in
core/,ui/, ordocs-site/only - Do not open PRs for proprietary enterprise or SaaS control-plane work here
- Ensure tests and (for UI)
npm run buildpass
See repository CONTRIBUTING.md and CODE_OF_CONDUCT.md for the full policy.