Skip to content

Document how a sync PR differs from an off-target direct edit #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremy merged 1 commit into from
Jul 23, 2026
Merged

Document how a sync PR differs from an off-target direct edit #417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,22 @@ content should be redirected to bc3.
Only repo-local files that the sync does not copy (this file, GitHub metadata)
may be edited directly.

### Sync PRs are expected — off-target edits are not

A PR that changes `README.md`, `CONDUCT.md`, or a `sections/*.md` file **should be
a sync PR** — the verbatim output of `script/api/sync_to_bc3_api`, which is the
only sanctioned way this content changes. So a PR modifying those files is
expected and correct — review the documentation on its merits; don't flag the sync
itself as an unauthorized direct edit. A sync PR's description carries this footer:

> Synced from bc3 `doc/api/` by `script/api/sync_to_bc3_api` — not a hand-edit.

An **off-target edit** hand-changes that content on a branch, bypassing the sync:
no footer, and it won't match bc3's `doc/api/`. Those are what to redirect to bc3;
the next sync overwrites them regardless. A PR that touches only this file or
GitHub metadata is the exception — the sync doesn't copy those, so they're edited
here directly and carry no footer.

## Section file format

Every `sections/*.md` follows this structure:
Expand Down