Skip to content

docs: add label taxonomy and milestone map to PR workflow #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shaypal5 merged 1 commit into from
Apr 18, 2026
+29 −1
Merged

docs: add label taxonomy and milestone map to PR workflow #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .agent-plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Current System State

Repository initialized. Codebase empty. Architecture, design, and roadmap documents are locked in `docs/`. Agent-context files (`CLAUDE.md`, `llms.txt`, `.agent-plan.md`) are initialized. Branch/PR workflow rules are locked in `CLAUDE.md` and enforced via `.git/hooks/pre-push`.
Repository initialized. Codebase empty. Architecture, design, and roadmap documents are locked in `docs/`. Agent-context files (`CLAUDE.md`, `llms.txt`, `.agent-plan.md`) are initialized. Branch/PR workflow rules (including label taxonomy and milestone map) are locked in `CLAUDE.md` and enforced via `.git/hooks/pre-push`. GitHub labels and milestones (v0.1–v1.0) are created.

---

Expand Down
28 changes: 28 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,37 @@
3. Do the work; commit to the branch.
4. Update `.agent-plan.md` to reflect project state *after* the PR merges; commit that update to the same branch (same PR).
5. Open a PR against `main` on GitHub with a detailed description.
6. Apply the appropriate **labels** to the PR (create new ones if none fit — see label taxonomy below).
7. Assign the PR to the appropriate **milestone** (create a new one on GitHub if none fits).

Never use `git push origin main`, `git push --force`, or any variant that targets `main` directly.

### Label taxonomy

**Type** (one required):
`type: feature` · `type: bugfix` · `type: docs` · `type: test` · `type: refactor` · `type: ci` · `type: chore`

**Layer** (one or more, when touching package code):
`layer: core` · `layer: narrative` · `layer: schema` · `layer: structure` · `layer: mechanisms` · `layer: simulation` · `layer: render` · `layer: exposure` · `layer: validation` · `layer: cli` · `layer: api` · `layer: recipes`

**Status** (optional):
`status: in progress` · `status: needs review` · `status: blocked`

Existing labels that predate this taxonomy: `bug` · `documentation` · `enhancement` · `good first issue` · `help wanted` · `foundation` — use when appropriate.

### Milestone map

| Milestone | Covers | Roadmap |
|---|---|---|
| v0.1.0 — Repo & CLI skeleton | M0 | Foundation, CI, package scaffold |
| v0.2.0 — First end-to-end world | M1–M3 | Config/recipe, narrative, schema |
| v0.3.0 — Motif variability + exposure modes | M4–M6 | Structure, mechanisms, exposure |
| v0.4.0 — Polished relational output + task export | M7–M10 | Simulation, observation, render, task |
| v0.5.0 — CLI-complete release candidate | M11–M13 | CLI, validation harness |
| v1.0.0 — Polished OSS release | M14–M15 | Sample data, notebooks, docs polish |
Comment on lines +32 to +39

If work spans multiple milestones, assign to the earliest one it unblocks.

---

## Project Identity
Expand Down