Skip to content

Docs: describe the --sync-bodies exception to the direction contract #9

Open

Description

@williamdemeo

Deferred from #7 (decision 3). The README's and CLAUDE.md's contract tables state a clean bidirectional rule — populate: file → GitHub at bootstrap; update: GitHub → file thereafter — and `populate --sync-bodies` is now a deliberate exception: file → GitHub for issue BODIES and milestone DESCRIPTIONS of already-existing items, on explicit request only, with refuse-on-divergence semantics (`--force` = last writer wins).

The concern: the contract tables are the template's core teaching device, and exceptions listed casually erode them. The docs need a formulation that keeps the tables crisp while stating precisely when the exception applies (explicit flag, existing items only, never run by workflows) and what protects GitHub-side edits (per-item divergence refusal; the engine stores no base version).

Activity

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions