Repository navigation
Align CONTRIBUTING.md's restated conventions and checklist with CLAUDE.md - #163
Merged
Merged
Conversation
…E.md Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (one pass, scored against the diff and the CI run):
Judgment call:
Nothing blocking; the PR is ready to merge. This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
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
Stage A documentation accuracy sweep. Every doc source of truth listed in
CLAUDE.mdwas checked againstcreate-dev-loop.md(Steps 1–7, the Step 4 substitution table, and what Steps 3/5/6/7 write).README.md,SECURITY.md, the PR template, the issue templates, andscripts/README.mdwere found accurate.CONTRIBUTING.mdhad drifted fromCLAUDE.mdin two places:CLAUDE.md's "Skill file conventions" requires two things thatCONTRIBUTING.mddid not mention: backslash-escaping fenced code blocks inside the template, and placing thetemplate-version/generated-atcomments directly below the H1 heading (the fix for Template-version HTML comment at file top breaks skill-list description for commands-format installs #36). Both are now restated.CLAUDE.md's "Testing changes" list. Item 4 said only that the comments "appear correctly". It now says they must sit below the H1, with the SHA matching the create-dev-loop commit the skill was generated from. Item 5 said only to "exerciseMODE=updateend-to-end". It now names the three things to confirm: the abort-on-uncommitted-changes check, the pre-overwrite diff prompt, and that Steps 6–7 are skipped.No tracking issue — gap found during triage.
Open issues not taken this cycle were deferred because nearly all of them change template behavior or
CLAUDE.md. Template-behavior changes need a manual/create-dev-loopvalidation run, which a headless dispatch cannot perform (#109).CLAUDE.mdedits need separate authorization (#106, and half of #128). A docs-only sweep was selected as the change that could be fully verified in this run.Doc sync check
No Step, placeholder, or
RESEARCH.mdfinding is touched, so none of the checkboxes apply.Test plan
python3 scripts/check_docs.py— "Doc consistency check passed."python3 -m unittest discover -s tests— Ran 41 tests, OK/create-dev-looprun is needed: this change is docs-only and does not touch the template (UNVERIFIED-not-applicable).This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson