Skip to content

docs: require divergence rows for upstream edits - #61

Merged
quickbeard merged 3 commits into
mainfrom
divergence-policy
Jul 13, 2026
Merged

quickbeard merged 3 commits into
mainfrom
divergence-policy

Conversation

@quickbeard

@quickbeard quickbeard commented Jul 13, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Add a fork-policy bullet to AGENTS.md: every deliberate change to an upstream file must get a DIVERGENCES.md row (file, change, why, on-conflict guidance) in the same PR — an unlisted divergence is a bug. Changes to documented behavior (e.g. keybind defaults) must also update the matching en + es docs under packages/web/src/content/docs/.
  • Add a second AGENTS.md bullet pointing agents at DIVERGENCES.md's Divergence policy (prefer config/plugins, then new packages/codev-* packages, upstream-file edits last) and Syncing with upstream runbook (never git merge upstream refs), so the placement rules get applied before code is written and syncs follow the 3-way-patch procedure.
  • Extend the existing AGENTS.md row in DIVERGENCES.md to record both bullets (the file was already listed for the default-branch note).
  • Move the Syncing with upstream runbook and the Divergence policy section out of README.md into DIVERGENCES.md, so everything about upstream tracking lives in one document. The README keeps a one-line pointer; the former cross-references between the two files become internal section links. Both files are fork-owned per the divergence table, so the move needs no new rows.

CLAUDE.md symlinks AGENTS.md, so agent instructions pick this up automatically.

🤖 Generated with Claude Code

quickbeard and others added 3 commits July 13, 2026 21:45
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@quickbeard
quickbeard merged commit a014a66 into main Jul 13, 2026
4 of 5 checks passed
@quickbeard
quickbeard deleted the divergence-policy branch July 13, 2026 15:23
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.

1 participant