Skip to content

docs(repo): capture rewrite and independent review practices - #6692

Merged
jgoux merged 2 commits into
developfrom
docs/rewrite-guidance
Sep 21, 2026
Merged

jgoux merged 2 commits into
developfrom
docs/rewrite-guidance

Conversation

@jgoux

@jgoux jgoux commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Adds tool-independent review checkpoints with bounded rounds and evidence-based consensus.

Strengthens existing guidance to design from consumer requirements, justify complexity with current needs, exercise shared contracts across implementations, and verify contract-required cleanup. Effect coding practices remain owned by the repository-local skill.

@jgoux
jgoux requested a review from a team as a code owner September 21, 2026 19:27
@jgoux jgoux self-assigned this Sep 21, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 AI Review

Both independent reviews completed; Codex reported no findings. Of Claude's four documentation nits, two are confirmed formatting/content regressions and two are refuted by the surrounding text and the distinct scope of the existing AI-review documentation.

Findings

Severity Location Category Sources Claim
⚪ NIT AGENTS.md:172 docs-style claude The new flake-resistance bullet is hard-wrapped while every other bullet in the same list is unwrapped, making the list formatting inconsistent.
⚪ NIT AGENTS.md:140 docs-content claude The Refactoring rewrite removes explicit general guidance to move responsibility to the correct owner and to delete obsolete helpers, shims, and parallel paths, replacing it with narrower wording.
Refuted findings (kept for transparency, not posted as review comments)
  • AGENTS.md:78 (docs-maintenance): The new Independent review section duplicates the repository's maintained AI-review mechanism without linking to it.
    Refuted: The documents cover materially different workflows. AGENTS.md:80-91 specifies iterative reviews at design and implementation checkpoints, potentially with several rounds; .github/ai-review/README.md:3-7 explicitly documents a GitHub Actions review that runs exactly once per PR. The new section is not copied documentation of that mechanism.
  • AGENTS.md:82 (docs-clarity): The authorization sentence can be read as blanket permission to invoke review tooling without asking the user.
    Refuted: AGENTS.md:81-83 expressly scopes the permission rule by first requiring adherence to the user's reviewer choice and that reviewer's authorization requirements, then limiting non-repetition to an already authorized workflow. The surrounding text therefore does not grant blanket authorization.

Stats

Claude findings: 4 · Codex findings: 0 · Confirmed: 2 · Refuted: 2 · Uncertain: 0


Models: claude-opus-5 + gpt-5.6-sol · Trigger: auto · Workflow run

This review runs once per PR. A maintainer can request another with a /ai-review comment.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
@jgoux
jgoux added this pull request to the merge queue Sep 21, 2026
Merged via the queue into develop with commit a42f3a7 Sep 21, 2026
45 checks passed
@jgoux
jgoux deleted the docs/rewrite-guidance branch September 21, 2026 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants