Skip to content

templates/family-root README.md and AGENTS-shape.md, AGENTS.md and validate-family.py: the holder's own docs say its parent folder is "named after the family" and omit "EXACTLY, case included", and "never hand-edit the members: block" is contradicted by the validator's repair remedies #763

Closed

Description

@brettheap

Goal: the holder's own README and AGENTS-shape.md say what the standard's README, the handbook and siblings.py say about the folder's name, and AGENTS.md, AGENTS-shape.md and validate-family.py agree on when a person may edit a row of family.yaml by hand.

Filed by lane openRepoShape-5, from rv695's review of #695's PR (#738, its N6, "could ride a later re-pin") and from the checklist candidate of #681's PR (#747, "AGENTS.md and the validator disagree on hand edits"). Words only; no behaviour changes.

Lands after: lane 5's #695 (PR #738, fix/695-family-docs, head c42286de), which writes "EXACTLY, case included" into the standard's README (README.md:913 at that head) and the handbook (docs/handbook.html:1343), and adds tests/test_family_docs_one_spelling.py, and #681 (PR #747), which adds the hand-edit remedy. The lines below are at main 66b230ed.

Pinned copies. templates/family-root/AGENTS-shape.md is pinned in every holder (FAMILY_COPIED_VERBATIM, scripts/shape_materialize.py:525-547), so a change to it rides in one upstream-changed row, with the shape bump. templates/family-root/README.md is rendered once at init (its {{FAMILY}} placeholders) and never re-rendered: update-shape.py apply does not touch it (#738's body), so a change reaches new holders only.

Lines

Verify: tests/test_family_docs_one_spelling.py (new in #738) with a case per file; tests/test_readme_sections.py, tests/test_pinned_copy_text.py, tests/test_repo_hygiene.py and tests/test_template_text_placeholders.py pass on Linux. For the second line, a test that reads AGENTS.md:398, AGENTS-shape.md:38 and the validator's two remedies and fails when one says "never" and another says to do it, as #738's file does for the folder sentence. No behaviour changes, so no docs/cli.md change unless a --help text moves.

Overlaps. fix/695-family-docs (#738) edits templates/family-root/README.md, templates/family-root/AGENTS-shape.md and AGENTS.md (other sentences: the --into sentence and the one-spelling sentence); l3-563-docs (#630) edits AGENTS.md and README. fix/681-validate-family-remedies (#747) and fix/648-bootstrap-and-gate-order (#682) edit validate-family.py; if the second line changes a remedy it lands after both. README.md has a line cap (tests/readme-cap.d/): no line here adds one to the standard's README.

Parent: #459.

Milestone: v1.1.1. Words only, and the three sentences are consistent with what the tools do today.

🤖 Generated with Claude Code

Activity

  1. added this to the v1.1.1 milestone on Oct 17, 2026
  2. brettheap commented on Oct 17, 2026

    @brettheap
    ContributorAuthor

    CLAIMED — lane openRepoShape-2, session 81650e29-c906-4fe8-96c9-55580bfe0c44@Eagle, 2026-10-17T10:32:41Z, for #763

    Logged in lanes/log/openRepoShape-2.md at aceadd440319bb9927e261e551c61a8fab6d1880.

    The three reads (lane-collision-protocol Rule 1):

    1. existing `CLAIMED —` comments on opensoft/openRepoShape#763:
       none
    2. `gh pr list --repo opensoft/openRepoShape --state all --search "#763"`, kept where the row or its body names `#763`:
       none
    3. `git ls-remote --heads git@github.com:opensoft/openRepoShape` branches naming `763` as a whole token:
       none
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions