chore: adopt planning-convention (fresh adopt at v1.0.0)#14
Merged
Conversation
Apply lesnik512/planning-convention via its APPLY.md (FRESH ADOPT):
- planning/index.py + planning/_templates/* — copied verbatim (canonical-owned).
- planning/README.md — repo-local title/intro + the portable Quick-path and
Conventions prose from convention.md, plus repo-local Index/Other sections.
- planning/{changes,decisions,releases}/ scaffolding, planning/deferred.md,
and architecture/README.md stating the same-PR promotion rule.
- planning/.convention-version pins 1.0.0.
- Justfile: add `index` and `check-planning`; wire `planning/index.py --check`
into `lint-ci`.
- CLAUDE.md: add `## Workflow` pointer to the Quick path and the
architecture/<capability>.md promotion reminder under `## Architecture`.
No coverage config change: planning/ has no __init__.py and is never imported,
so the script is excluded from `--cov=.` and the 100% gate holds (verified).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Reformat the lone ADR into the convention's decision format and home: docs/adr/0001-expose-installs-into-modules-only.md -> planning/decisions/2026-06-26-expose-installs-into-modules-only.md (status/summary frontmatter; Context / Decision & rationale / Revisit trigger). Now listed by `just index`. Remove the empty docs/adr tree and drop the pre-convention pointer from planning/README.md's Other section. 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.
Applies
lesnik512/planning-conventionto this repo per itsAPPLY.md. Fresh adopt at v1.0.0 (no priorplanning/.convention-version).What landed
Canonical-owned, copied verbatim
planning/index.py— validator + index generator (--checkvalidates bundle/decision name format, bundle shape, required frontmatter; default prints the newest-first index).planning/_templates/{change,design,plan,decision,release}.md.Repo-local
planning/README.md— repo title/intro + the portable Quick-path and Conventions prose fromconvention.md, plus repo-local## Index/## Other.planning/{changes,decisions,releases}/(.gitkeep),planning/deferred.md,architecture/README.md(states the same-PR promotion rule).planning/.convention-version→1.0.0.Judgment-merges
Justfile: addedindexandcheck-planning; wireduv run python planning/index.py --checkintolint-ci.CLAUDE.md: added## Workflowpointer to the Quick path, and thearchitecture/<capability>.mdpromotion reminder under## Architecture.ADR migration (follow-on)
docs/adr/0001-expose-installs-into-modules-only.md→planning/decisions/2026-06-26-expose-installs-into-modules-only.md(withstatus/summaryfrontmatter; Context / Decision & rationale / Revisit trigger). It now shows injust index. Removed the emptydocs/adr/tree and the pre-convention pointer from the README.Deviation from APPLY.md
None functionally. I considered a
[tool.coverage.run] omit = ["planning/*"]to protect the--cov=.100% gate, but verified it's unnecessary:planning/has no__init__.pyandindex.pyis never imported, so coverage doesn't treat it as source.pyproject.tomlis therefore untouched.Verification
just check-planning→planning: OK(validates the migrated decision)just index→ lists the decision, date/slug derived from filenamejust lint-ci→ ruff format/check + ty + planning check all passjust test-ci→ 16 passed, 100% coverage held🤖 Generated with Claude Code