Skip to content
SpineSpineSpine Docs

Contributing

The full guide is CONTRIBUTING.md. In short:

  • Start with an issue for anything beyond a small fix, and check it’s in scope (overview, roadmap).
  • Work from a story in docs/features/, and put its id in the commit message and the pull request (US-INV-05: …).
  • Branches: work is grouped into phases. Each phase is a branch, phase-<n>-<name>, from main, with one commit per story and one pull request into main when the phase is done. Never commit to main directly.
  • Run the checks locally — lint, typecheck, tests and pnpm verify — because CI runs only on the pull request (Testing).
  • Keep the docs in step: the story’s tick in docs/progress.md, a CHANGELOG.md entry, the QA script, the spec for any contract you change, and the user guide page for anything people see.
  • Sign off every commit with git commit -s (Developer Certificate of Origin; no CLA).

Licence

Section titled “Licence”

Spine is AGPL-3.0-only, copyright Hari Prasad. You can self-host it, change it and share it; anyone running a modified copy as a service must offer its source. Contributions are accepted under the same licence.