Skip to content

Commit 6e52837

Browse files
committed
docs: codify review hygiene after #314 (#315)
1 parent 5ed15dc commit 6e52837

8 files changed

Lines changed: 23 additions & 11 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
- **YOU MUST** use Playbacks to judge whether work actually moved a Hill
3333
- **YOU MUST** treat tests as the executable form of design acceptance criteria for substantial work
3434
- **YOU MUST** prefer canonical repo fixtures over ad hoc temp-repo setup when testing repository-shaped behavior
35+
- **YOU MUST** resolve stale review threads and document false positives before merge
3536
- **YOU MUST** tag all memories saved to your memory banks with at least `#git-mind`
3637
- **YOU MUST** include the POSIX timestamp (via `$(date +%s)`) in memory file names
3738
- **YOU MUST** document significant decisions or events

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
- **YOU MUST** use Playbacks to judge whether work actually moved a Hill
3333
- **YOU MUST** treat tests as the executable form of design acceptance criteria for substantial work
3434
- **YOU MUST** prefer canonical repo fixtures over ad hoc temp-repo setup when testing repository-shaped behavior
35+
- **YOU MUST** resolve stale review threads and document false positives before merge
3536
- **YOU MUST** tag all memories saved to your memory banks with at least `#git-mind`
3637
- **YOU MUST** include the POSIX timestamp (via `$(date +%s)`) in memory file names
3738
- **YOU MUST** document significant decisions or events

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ For substantial work:
4545
4. implement until the tests are green
4646
5. run a playback / retrospective and capture backlog follow-ups
4747
6. update [README.md](README.md) if user-facing reality changed
48-
7. open the PR, land it, and capture review-cycle learnings back into the backlog
48+
7. open the PR and process review feedback
49+
8. resolve stale review threads and document false positives before merge
50+
9. land it, then capture review-cycle learnings back into the backlog
4951

5052
This is not just for happy paths.
5153
Tests should cover edge cases, failure modes, and fuzz/stress behavior when the design risk justifies it.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ That means:
4949
4. implement until the tests are green
5050
5. run a playback / retrospective and capture backlog items and follow-on ideas explicitly
5151
6. update `README.md` if product reality changed
52-
7. land the PR, then capture review-cycle learnings back into the backlog
52+
7. open the PR and process review feedback
53+
8. resolve stale review threads and document false positives before merge
54+
9. land the PR, then capture review-cycle learnings back into the backlog
5355

5456
For repository-shaped behavior, prefer canonical repo fixtures over one-off temporary repo setup.
5557
See [docs/design/repo-fixture-strategy.md](docs/design/repo-fixture-strategy.md) and [docs/adr/ADR-0006.md](docs/adr/ADR-0006.md).

ROADMAP.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,9 @@ Substantial delivery work should follow the repository's canonical cycle from [A
100100
4. implement until the tests are green
101101
5. run a playback / retrospective
102102
6. update `README.md` if shipped reality changed
103-
7. land the PR and capture review learnings back into the backlog
103+
7. open the PR and process review feedback
104+
8. resolve stale review threads and document false positives before merge
105+
9. land the PR and capture review learnings back into the backlog
104106

105107
The first Hill 1 implementation cycles should explicitly invest in the testing substrate needed to make bootstrap behavior executable and trustworthy.
106108

@@ -109,6 +111,7 @@ The first Hill 1 implementation cycles should explicitly invest in the testing s
109111
Status:
110112

111113
- in progress
114+
- prerequisite substrate upgrade merged via issue [#312](https://github.com/flyingrobots/git-mind/issues/312)
112115

113116
Sponsor user:
114117

@@ -124,7 +127,6 @@ Goal:
124127

125128
Deliverables:
126129

127-
- git-warp audit / upgrade cycle before major Hill 1 implementation (issue [#312](https://github.com/flyingrobots/git-mind/issues/312))
128130
- bootstrap command contract with default write behavior and `--dry-run`
129131
- canonical repo fixture substrate for repository-shaped bootstrap scenarios (issue [#311](https://github.com/flyingrobots/git-mind/issues/311))
130132
- repo-local artifact inventory and scan boundaries
@@ -150,7 +152,7 @@ Primary references:
150152
- [docs/design/git-warp-upgrade-audit.md](docs/design/git-warp-upgrade-audit.md)
151153
- [docs/design/repo-fixture-strategy.md](docs/design/repo-fixture-strategy.md)
152154
- issue [#303](https://github.com/flyingrobots/git-mind/issues/303)
153-
- issues [#304](https://github.com/flyingrobots/git-mind/issues/304), [#305](https://github.com/flyingrobots/git-mind/issues/305), [#306](https://github.com/flyingrobots/git-mind/issues/306), [#307](https://github.com/flyingrobots/git-mind/issues/307), [#310](https://github.com/flyingrobots/git-mind/issues/310), [#311](https://github.com/flyingrobots/git-mind/issues/311), and [#312](https://github.com/flyingrobots/git-mind/issues/312)
155+
- issues [#304](https://github.com/flyingrobots/git-mind/issues/304), [#305](https://github.com/flyingrobots/git-mind/issues/305), [#306](https://github.com/flyingrobots/git-mind/issues/306), [#307](https://github.com/flyingrobots/git-mind/issues/307), [#310](https://github.com/flyingrobots/git-mind/issues/310), and [#311](https://github.com/flyingrobots/git-mind/issues/311)
154156

155157
---
156158

docs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ These describe what Git Mind is now and how work should be judged:
1212
- [ROADMAP.md](../ROADMAP.md) — active Hills, supporting lanes, and playback cadence
1313
- [Git Mind Product Frame](./design/git-mind.md) — IBM Design Thinking style product frame
1414
- [Hill 1 Semantic Bootstrap Spec](./design/h1-semantic-bootstrap.md) — first executable Hill 1 slice
15-
- [git-warp Upgrade Audit](./design/git-warp-upgrade-audit.md)next enabling cycle before major Hill 1 implementation
15+
- [git-warp Upgrade Audit](./design/git-warp-upgrade-audit.md)completed enabling cycle that revalidated the git-warp substrate before Hill 1 implementation
1616
- [Git Mind North Star](./VISION_NORTH_STAR.md) — longer-form strategic articulation
1717
- [ADR-0005](./adr/ADR-0005.md) — official planning and governance model
1818
- [ADR-0006](./adr/ADR-0006.md) — official delivery cycle and tests-as-spec model
@@ -88,4 +88,5 @@ When implementing substantial work, continue with:
8888
1. explicit acceptance criteria
8989
2. failing tests
9090
3. shared repo fixtures where repository behavior matters
91-
4. playback evidence and README reality updates before cycle close
91+
4. review-hygiene cleanup for stale threads and false positives before merge
92+
5. playback evidence and README reality updates before cycle close

docs/adr/ADR-0006.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ If the shipped behavior changes the user-facing truth of the product, update `RE
8181
The cycle does not end at "tests green."
8282
It ends after:
8383

84+
- review feedback is processed and stale or false-positive threads are explicitly resolved
8485
- the PR is reviewed and merged to `main`
8586
- learnings from review are captured back into the backlog
8687
- any follow-on ideas are explicitly recorded instead of left implicit
@@ -95,8 +96,10 @@ The canonical Git Mind delivery cycle is:
9596
4. Implement until the tests are green.
9697
5. Run the playback / retrospective.
9798
6. Update the README if product reality changed.
98-
7. Open and land the PR to `main`.
99-
8. Capture post-merge review learnings and follow-on ideas in the backlog.
99+
7. Open the PR and process review feedback.
100+
8. Resolve stale review threads and document false positives before merge.
101+
9. Land the PR to `main`.
102+
10. Capture post-merge review learnings and follow-on ideas in the backlog.
100103

101104
## Alternatives Rejected
102105

docs/design/git-warp-upgrade-audit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# git-warp Upgrade Audit
22

3-
Status: active execution on `feat/git-warp-upgrade-audit`
3+
Status: completed and merged via PR [#314](https://github.com/flyingrobots/git-mind/pull/314)
44

55
Related:
66

@@ -12,7 +12,7 @@ Related:
1212

1313
## Purpose
1414

15-
Define the next enabling cycle before major Hill 1 implementation:
15+
Define the enabling cycle that preceded major Hill 1 implementation:
1616

1717
> audit and upgrade Git Mind's `@git-stunts/git-warp` dependency so new Hill 1 work is not built on an outdated substrate by accident.
1818

0 commit comments

Comments
 (0)