Adopt portable two-axis planning convention#55
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Also remove the bare plan.md gitignore rule, incompatible with the per-bundle plan.md the convention introduces. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…d rename) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…nal/decoder wording Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…bundles The pre-migration planning/specs and planning/plans files lacked trailing newlines; eof-fixer . --check (run by just lint-ci) flags them. Normalized to match the rest of the tree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…pts/ Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
deferred.md had a now-broken markdown link to engineering.md §8 (roadmap, dissolved); 0.6.0 release note had a bare engineering.md §2 prose ref. Both missed in the link-repoint pass because they lacked the planning/ prefix. 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.
Summary
Adopts the portable two-axis planning convention from sibling repo
faststream-outbox. Docs/planning-only — zerosrc//tests/changes.planning/engineering.mdinto eight present-tense, frontmatter-free per-capability files underarchitecture/(repo root):overview, client, middleware, decoders, errors, resilience, extras, testing.engineering.mddeleted. The split also folds in CircuitBreaker/AsyncTimeout (0.10.0), whichengineering.mdpredated — soarchitecture/is more current than its source.planning/changes/archive/<YYYY-MM-DD.NN-slug>/{design,plan}.mdbundles with full backfilled frontmatter (status: shipped, date, slug, pr, outcome, supersedes/superseded_by)..NNordering derived from git merge order / PR number. This convention-adoption is itself the inauguralplanning/changes/active/bundle.planning/audit/→planning/audits/(+scripts/for the.mjs/.jsontooling);planning/deferred-work.md→planning/deferred.md;retros/andreleases/unchanged.planning/README.md: repo intro + a byte-identical## Conventionsblock (shared across modern-python repos) + repo-specific Index (1 Active + 40 Archived + Other).docs/,CLAUDE.md, andplanning/releases/repointed toarchitecture// the new bundle paths. Frozen history (archived bundle bodies, audit findings, retros) intentionally still quotes the paths as they were when written.plan.mdrule from.gitignorethat would have left every bundle'splan.mduntracked.Test Plan
just lint-ci— eof-fixer, ruff format/check, ty all cleanmkdocs build --strict— clean build, no broken linksjust test— 569 passed, 100% coverage (unaffected)engineering.mdgone; no staleplanning/(specs|plans|archive|audit|deferred-work)refs in any live docarchitecture/= exactly 8 files, none with frontmatter;changes/active/holds only this bundle; 40 archived bundlesFollow-up
On merge: promote this change into the affected
architecture/files (n/a — it defines them), set the active bundle frontmatter tostatus: shipped+pr, and move it tochanges/archive/, shifting its README Index line from Active to Archived — the first exercise of the convention's promotion step.🤖 Generated with Claude Code