Skip to content
BETACurrent release v0.2.0-betaRelease notesGitHub

Contributing

Contributions are welcome. The repository’s CONTRIBUTING.md is the source of truth; this is the summary.

Branch Role
dev the default integration branch for feature work and normal pull requests
stage pre-release branch where selected changes are gathered and checked together
main the protected release branch

Flow: branch from dev → open a PR into dev → promote chosen changes to stage → validate → merge stage into main → tag a release such as v1.0.0.

  • Keep them focused.
  • Include tests or build verification where applicable.
  • Update docs when behaviour changes (these docs live in docs/).
  • Avoid bundling unrelated frontend, backend and website work together.
Terminal window
cd docs
npm install
npm run dev
npm run build # also fails on broken internal links

Pages are Markdown in docs/src/content/docs/. Screenshots live in docs/src/assets/screenshots/.

Support the project: Buy Me a Coffee or GitHub Sponsors.