chore: adopt canonical planning convention + compact CLAUDE.md#44
Merged
Conversation
Vendor the canonical index.py + templates from lesnik512/planning-convention, slim every bundle/decision frontmatter to the lean form (date/slug derived from the dir/file name; specs carry summary only; plans carry none), update planning/README.md frontmatter prose, add the check-planning recipe and wire the validator into lint-ci, add architecture/README.md, and pin planning/.convention-version to 1.0.0. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the duplicated Architecture deep-dives with terse invariant summaries and a capability->file index pointing at architecture/. Promote the orphan "Integration tests" section into architecture/integration-tests.md. Compact Commands to a Justfile pointer and Workflow to a planning/README.md pointer. 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.
Adopts the canonical two-axis planning convention (sourced from
lesnik512/planning-convention) and compactsCLAUDE.mdto mirror thefaststream-outboxpilot.Convention adoption
planning/index.py+_templates/*.mdverbatim from the canonical repo (addsrelease.mdtemplate).date/slugare derived from the dir/file name;design.md/change.mdcarrysummaryonly;plan.mdcarries no frontmatter; decisions carrystatus+summary.planning/README.mdFrontmatter + Index prose to the lean form.check-planningrecipe and wireuv run python planning/index.py --checkintolint-ci.architecture/README.md(truth-home intro + capability list + promotion rule).planning/.convention-versionto1.0.0.CLAUDE.md compaction (82 -> 72 lines)
## Architecturedeep-dives with invariant summaries ("what must not break") + a capability->file index table pointing atarchitecture/, plus the same-PR promotion reminder.## Integration testssection into a newarchitecture/integration-tests.mdcapability page.## Commandsto ajust --listpointer (non-obvious notes kept) and## Workflowto aplanning/README.mdQuick-path pointer.Conventions(type suppression, no__future__, module-level imports).Verification
just lint-ci(eof-fixer + ruff format + ruff check + ty + planning validator) andjust check-planningboth green.