chore: adopt canonical planning convention#16
Merged
Conversation
Fresh-adopt the portable two-axis planning convention from lesnik512/planning-convention (v1.0.0): - Vendor planning/index.py (validator + index generator) and planning/_templates/ (change, design, plan, decision, release). - Add planning/README.md with the Quick path + Conventions prose and planning/.convention-version (1.0.0); scaffold changes/, decisions/, releases/ directories. - Add architecture/README.md as the per-capability truth home with the promotion rule (no capability files yet — repo authors its own). - Wire `uv run python planning/index.py --check` into `lint-ci`; add `index` and `check-planning` recipes to the Justfile. - Point CLAUDE.md § Workflow at planning/README.md's Quick path and add the architecture promotion reminder. just lint-ci green (ruff + ty + planning validator); check-planning: OK.
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.
Fresh-adopt the portable two-axis planning convention from
lesnik512/planning-convention(v1.0.0), bringing this repo in line with the siblingmodern-di/faststream-outboxprojects.What changed
planning/index.py(validator + index generator) andplanning/_templates/(change · design · plan · decision · release).planning/README.md(Quick path + Conventions prose),planning/.convention-version=1.0.0, and scaffoldedchanges/,decisions/,releases/directories.architecture/README.md— the per-capability truth home with the promotion rule. No capability files yet; the repo authors its own as changes ship.uv run python planning/index.py --checkintolint-ci(CI runsjust lint-ci); addedindexandcheck-planningrecipes.## Workflownow points atplanning/README.md's Quick path and carries the architecture promotion reminder.The pre-convention
planning/specs/design doc (FastStream 0.7 migration) is retained for history; the validator only inspectschanges/anddecisions/.Notes
pyproject.tomlignores D213, not D212, so the vendoredindex.py'snoqa: D212is used.Verification
just lint-cigreen (ruff + ty + planning validator);just check-planningprintsplanning: OK.