You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a37b899
Browse filesBrowse the repository at this point in the historyBrowse files
chore(planning): bump convention to 2.0.0 (flat change files) (#93)
Applies the lesnik512/planning-convention APPLY.md 1.x->2.0.0 update:
swap index.py + templates (glossary.md added, plan.md template
dropped), flatten all 59 change folders into flat change files and
drop their committed plan.md (48 removed), merge the 2.0.0 convention
prose into planning/README.md, align CLAUDE.md/Justfile wording, and
record planning/.convention-version=2.0.0.
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CLAUDE.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,12 @@ Guidance for AI agents (Claude Code, etc.) working in this repository.
10
10
11
11
-[`architecture/`](architecture/) (repo root) — the per-capability living truth, one file per capability ([`architecture/README.md`](architecture/README.md) is the index). The promotion target on every ship. **Read the relevant file before changing that capability.**
12
12
-[`planning/README.md`](planning/README.md) — the planning convention (Quick path + the two-axis convention) and the generated change Index.
13
-
-[`planning/changes/<YYYY-MM-DD.NN-slug>/`](planning/changes/) — per-change bundles (`design.md` + `plan.md`, or `change.md` for the lightweight lane).
13
+
-[`planning/changes/<YYYY-MM-DD.NN-slug>.md`](planning/changes/) — flat change files, one per change (design template for the full lane, change template for the lightweight lane).
Planning follows the portable two-axis convention — `architecture/` (repo root) is the living **truth home** and promotion target; `planning/changes/` holds the per-change bundles. **Start at the [Quick path](planning/README.md#quick-path-start-here)** in `planning/README.md` to choose a lane (Full / Lightweight / Tiny), create a bundle, and ship — that file is the authoritative spec. Run `just check-planning` to validate bundles and `just index` to print the change listing.
18
+
Planning follows the portable two-axis convention — `architecture/` (repo root) is the living **truth home** and promotion target; `planning/changes/` holds the flat change files. **Start at the [Quick path](planning/README.md#quick-path-start-here)** in `planning/README.md` to choose a lane (Full / Lightweight / Tiny), create a change file, and ship — that file is the authoritative spec. Run `just check-planning` to validate changes and `just index` to print the change listing.
(`.01`, `.02`, …) that breaks same-date ties so the timeline sorts stably.
@@ -65,25 +83,44 @@ A change is a folder `changes/YYYY-MM-DD.NN-<slug>/`:
65
83
`summary` is written when the change is created (the intent one-liner) and
66
84
**finalized at ship** to state the realized result — set in the implementing
67
85
PR, alongside the code and the `architecture/` promotion. No post-merge
68
-
bookkeeping, no folder move. `date` and `slug` are never written — they are
69
-
read from the bundle's directory name.
86
+
bookkeeping, no file move. `date` and `slug` are never written — they are
87
+
read from the file name.
70
88
71
89
### Three lanes
72
90
73
91
| Lane | Artifacts | Use when |
74
92
|------|-----------|----------|
75
-
|**Full**|`design.md` + `plan.md`| design judgment; new file/module; public-API change; cross-cutting/multi-file; non-trivial test design |
76
-
|**Lightweight**|`change.md`| small-but-real: ≲30 LOC net, ≤2 files, no new file, no public-API change, single straightforward test |
93
+
|**Full**|one change file from the design template| design judgment; new file/module; public-API change; cross-cutting/multi-file; non-trivial test design |
94
+
|**Lightweight**|one change file from the change template| small-but-real: ≲30 LOC net, ≤2 files, no new file, no public-API change, single straightforward test |
0 commit comments