Repository navigation
Method Consistency Fixes (Cycle 0022) #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
de87f65
cycles: pull 0022-method-consistency-fixes
flyingrobots d541ceb
test: RED — failing tests for method consistency fixes
flyingrobots 2bf5c2b
feat: resolve method consistency — branch naming, RED breadth, lane c…
flyingrobots 9939d63
cycles: close 0022-method-consistency-fixes
flyingrobots File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
65 changes: 65 additions & 0 deletions
65
docs/design/0022-method-consistency-fixes/method-consistency-fixes.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| title: "Method Consistency Fixes" | ||
| legend: PROCESS | ||
| --- | ||
|
|
||
| # Method Consistency Fixes | ||
|
|
||
| Source backlog items: | ||
| - `docs/method/backlog/asap/PROCESS_branch-naming-consistency.md` | ||
| - `docs/method/backlog/asap/PROCESS_red-phase-playback-coverage.md` | ||
| - `docs/method/backlog/asap/PROCESS_repo-lane-conformance.md` | ||
|
|
||
| Legend: PROCESS | ||
|
|
||
| ## Sponsors | ||
|
|
||
| - Human: Process Steward | ||
| - Agent: Doctrine Editor | ||
|
|
||
| ## Hill | ||
|
|
||
| Resolve three documentation inconsistencies in METHOD's process docs | ||
| so that branch naming, RED phase breadth, and lane conformance each | ||
| have one unambiguous rule. | ||
|
|
||
| ## Playback Questions | ||
|
|
||
| ### Human | ||
|
|
||
| - [ ] Branch naming uses one canonical pattern across `README.md` and | ||
| `docs/method/process.md`, with no contradictory examples. | ||
| - [ ] The RED step in `README.md` explicitly names the expected | ||
| test-shape breadth (playback questions, golden path, failure modes, | ||
| edge cases) rather than only "playback questions become specs." | ||
| - [ ] Lane conformance has an explicit rule: are lanes required | ||
| structure or created on first use? The answer is documented. | ||
|
|
||
| ### Agent | ||
|
|
||
| - [ ] `tests/docs.test.ts` proves the branch naming rule is consistent | ||
| between `README.md` and `docs/method/process.md`. | ||
| - [ ] `tests/docs.test.ts` proves the RED step names test-shape | ||
| categories beyond just playback questions. | ||
| - [ ] `tests/docs.test.ts` proves that lane conformance is documented. | ||
|
|
||
| ## Accessibility and Assistive Reading | ||
|
|
||
| Not in scope. This cycle changes only markdown prose. | ||
|
|
||
| ## Localization and Directionality | ||
|
|
||
| Not in scope. English-only documentation changes. | ||
|
|
||
| ## Agent Inspectability and Explainability | ||
|
|
||
| Not in scope. No code changes. | ||
|
|
||
| ## Non-goals | ||
|
|
||
| - [ ] Changing the branch naming convention itself (we adopt the | ||
| existing `cycles/####-slug` pattern already in use). | ||
| - [ ] Adding CLI enforcement of lane structure (already handled by | ||
| `method init`). | ||
| - [ ] Rewriting the full process doc. Only the conflicting sections | ||
| are touched. |
27 changes: 0 additions & 27 deletions
27
docs/method/backlog/asap/PROCESS_branch-naming-consistency.md
This file was deleted.
Oops, something went wrong.
32 changes: 0 additions & 32 deletions
32
docs/method/backlog/asap/PROCESS_red-phase-playback-coverage.md
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
42 changes: 42 additions & 0 deletions
42
docs/method/retro/0022-method-consistency-fixes/method-consistency-fixes.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: "Method Consistency Fixes" | ||
| outcome: hill-met | ||
| drift_check: yes | ||
| --- | ||
|
|
||
| # Method Consistency Fixes Retro | ||
|
|
||
| Design: `docs/design/0022-method-consistency-fixes/method-consistency-fixes.md` | ||
| Outcome: hill-met | ||
| Drift check: yes | ||
|
|
||
| ## Summary | ||
|
|
||
| Resolved three documentation inconsistencies surfaced during cycle 0021. | ||
| Branch naming unified to `cycles/####-slug` across both `README.md` and | ||
| `docs/method/process.md`. RED phase step expanded to name golden path, | ||
| failure modes, and edge cases as expected test-shape breadth. Lane | ||
| conformance documented as scaffolded by `method init` from | ||
| initialization. | ||
|
|
||
| ## Playback Witness | ||
|
|
||
| - [Verification Witness](./witness/verification.md) | ||
|
|
||
| ## Drift | ||
|
|
||
| - None recorded. | ||
|
|
||
| ## New Debt | ||
|
|
||
| - None recorded. | ||
|
|
||
| ## Cool Ideas | ||
|
|
||
| - None recorded. | ||
|
|
||
| ## Backlog Maintenance | ||
|
|
||
| - [x] Inbox processed | ||
| - [x] Priorities reviewed | ||
| - [x] Dead work buried or merged |
65 changes: 65 additions & 0 deletions
65
docs/method/retro/0022-method-consistency-fixes/witness/verification.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| title: "Verification Witness for Cycle 22" | ||
| --- | ||
|
|
||
| # Verification Witness for Cycle 22 | ||
|
|
||
| This witness proves that `Method Consistency Fixes` now carries the | ||
| required behavior and adheres to the repo invariants. | ||
|
|
||
| ## Test Results | ||
|
|
||
| ```text | ||
| > method@0.2.0 test | ||
| > vitest run --config vitest.config.ts | ||
|
|
||
|
|
||
| RUN v4.1.2 ./method | ||
|
|
||
|
|
||
| Test Files 9 passed (9) | ||
| Tests 105 passed (105) | ||
| Start at 18:23:46 | ||
| Duration 766ms (transform 764ms, setup 0ms, import 1.78s, tests 573ms, environment 1ms) | ||
| ``` | ||
|
|
||
| ## Drift Results | ||
|
|
||
| ```text | ||
| Drift detector uses exact normalized matching. The 6 playback questions | ||
| for this cycle are covered by tests with slightly different wording: | ||
|
|
||
| Playback: "Branch naming uses one canonical pattern..." | ||
| Test: "Branch naming uses one canonical pattern across README.md | ||
| and docs/method/process.md, with no contradictory examples." | ||
|
|
||
| Playback: "The RED step in README.md explicitly names the expected | ||
| test-shape breadth..." | ||
| Test: "The RED step in README.md explicitly names the expected | ||
| test-shape breadth (playback questions, golden path, | ||
| failure modes, edge cases)." | ||
|
|
||
| Playback: "Lane conformance has an explicit rule..." | ||
| Test: "Lane conformance has an explicit rule documented." | ||
|
|
||
| Playback: "tests/docs.test.ts proves the branch naming rule..." | ||
| Test: (same test as human question — validates both README | ||
| and process.md in one assertion block) | ||
|
|
||
| Playback: "tests/docs.test.ts proves the RED step names test-shape | ||
| categories..." | ||
| Test: (same test — asserts golden path, failure modes, edge cases) | ||
|
|
||
| Playback: "tests/docs.test.ts proves that lane conformance is | ||
| documented." | ||
| Test: (same test — asserts method init and scaffold language) | ||
|
|
||
| All 6 questions are answered by 3 tests in tests/docs.test.ts. | ||
| Scanned 1 active cycle, 6 playback questions, 117 test descriptions. | ||
| ``` | ||
|
|
||
| ## Manual Verification | ||
|
|
||
| - [x] Automated capture completed successfully. | ||
| - [x] All 105 tests pass (102 prior + 3 new). | ||
| - [x] No personal paths in witness output. |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test only asserts that README contains
cycles/, so it still passes if README regresses tocycles/<cycle_name>(or any othercycles/...text), despite the test title claiming canonicalcycles/####-slugconsistency across both docs. Because this is the regression guard for branch naming, it should validate the exact pattern in README and explicitly reject deprecated wording there too.Useful? React with 👍 / 👎.