Contributing¶
All work in this repository follows the project constitution. It applies to every contributor, human or AI. AI coding agents such as Claude Code must read and follow it, and must flag a request that conflicts with it rather than silently deviating.
Workflow¶
Every feature follows the Spec Kit flow:
- Specify: describe what the feature must do (
/speckit-specify). - Plan: design how it is built and check it against the constitution
(
/speckit-plan). - Tasks: break the plan into tasks (
/speckit-tasks). - Implement: build it (
/speckit-implement).
Specs and plans live in specs/ in the repository.
Branches and pull requests¶
Every new spec and every code or documentation change is made on a new branch
created from the latest main. Nothing is committed directly to main: changes reach
it only through a pull request, and main is protected to enforce this. Use one branch
per spec or change, and don't reuse a branch after its pull request is merged.
| Created by | Spec Kit feature | Any other change |
|---|---|---|
| Human | NNN-short-name (e.g. 002-license-validation) |
<type>/<short-desc> (e.g. fix/readme-link) |
| Claude (AI agent) | claude/NNN-short-name (e.g. claude/002-license-validation) |
claude/<type>-<short-desc> (e.g. claude/fix-readme-link) |
NNN-short-nameis Spec Kit's sequential feature numbering. The spec directory is alwaysspecs/NNN-short-name/, without theclaude/prefix.<type>is one offeat,fix,docs,chore,refactor,test.- Every branch created by Claude starts with
claude/, so AI-authored work is easy to recognize. - A pull request can only be merged when the
builddocumentation check passes.
Releases¶
Releases are cut by pushing a version tag such as v2.1.0 or v2.1.0-beta1 on main;
the build computes the version and publishes the packages. See Releasing.
Documentation¶
Every change updates the documentation in the same pull request. See Documentation for where each kind of change goes and how to preview the site.