chore: adopt canonical planning convention + compact CLAUDE.md#137
Merged
Conversation
Vendor the canonical planning index.py + templates, slim every bundle's frontmatter to the lean form (summary only on specs; no frontmatter on plans; status+summary on decisions; date/slug derived from names), merge the three multi-PR bundles' per-PR plan files into one plan.md each, and update planning/README.md to the lean frontmatter prose. Wire the validator into CI: add the check-planning recipe and run planning/index.py --check in lint-ci. Add architecture/README.md (truth home intro + capability list + promotion rule) and pin the applied convention version in planning/.convention-version. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ndex Replace the duplicated Architecture deep-dives with terse invariant summaries, a promotion reminder, and a capability->file index pointing at architecture/; compact Commands to a just --list pointer with the which-to-use-when notes, and Workflow to a pointer at planning/README.md's Quick path. The audit-work coding rules keep their actionable guidance and gain architecture/ pointers. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Convention adoption (
lesnik512/planning-conventionv1.0.0):planning/index.py(now a flat newest-first index with a--checkvalidator) and refreshplanning/_templates/.summaryonly, plans carry no frontmatter, decisions carrystatus+summary(+ optional supersedes links);date/slugare derived from directory/file names.plan-prN-*.md) into oneplan.mdeach, preserving every plan verbatim as sections (the validator allows onlydesign.md/plan.md/change.mdper bundle).planning/README.mdto the lean frontmatter prose and canonical-repo sourcing note.check-planningrecipe +planning/index.py --checkstep inlint-ci.architecture/README.md(truth-home intro + capability list + promotion rule) and pinplanning/.convention-version=1.0.0.D213(notD212), so the vendoredindex.py'snoqa: D212is already correct.CLAUDE.md compaction (mirrors the faststream-outbox pilot):
## Architectureis now a one-line orientation + promotion reminder + invariant-summary bullets + a capability→file index, instead of duplicated deep-dives (the detail already lives inarchitecture/config-model.md,instruments.md,bootstrappers.md). No orphan subsections needed promotion — all three capabilities already had pages.## Commands→just --listpointer with which-to-use-when notes;## Workflow→ pointer atplanning/README.md's Quick path. Audit-work coding rules keep their actionable guidance and gainarchitecture/pointers.Verification
just lint-cigreen (eof-fixer, ruff format, ruff check, ty, planning validator) andjust check-planningprintsplanning: OK.