docs: add SYNC.md protocol for upstream sync - #4
Merged
Alezander9 merged 1 commit intoApr 23, 2026
Merged
Alezander9 merged 1 commit into
Alezander9 merged 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Codifies the 7-step protocol first executed in PR #3 so future maintenance agents don't re-derive it. Complements UPSTREAM.md (the sync log + modification zones) — SYNC.md is the how, UPSTREAM.md is the why and the record. Incorporates friction fixes surfaced by PR #3: - Step 1 is explicitly 'git checkout main && git pull origin main' so stale-main doesn't silently produce a stale sync. - Step 7 documents that gh pr create fails against our PAT via GraphQL but REST works; includes the curl command. Notes user+scope so this is not re-debugged. - Troubleshooting section calls out the bun-version guard in husky/pre-push and the fix (upgrade bun, don't patch the hook). Also documents merge-commit rationale, release-tag vs dev-commit anchoring, typical conflict set with resolution rules, Yellow-zone audit grep, and PR body template.
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
1 participant
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
Codifies the 7-step upstream sync protocol that was first executed live in PR #3. Future maintenance agents follow SYNC.md; they don't re-derive. Complements UPSTREAM.md (the sync log + modification zones) — SYNC.md is the how; UPSTREAM.md is the why and the record.
What's in it
Friction this PR addresses (from PR #3 reflection)
Not addressed here
SYNC.md is agent-facing. It does not replace anything in AGENTS.md; it's referenced alongside UPSTREAM.md as the sync-specific runbook.
Verification
This PR's own push exercised the full protocol end-to-end: