docs: correct merge strategy to squash-only in collab spec#91
Open
JasonJarvan wants to merge 1 commit into
Open
docs: correct merge strategy to squash-only in collab spec#91JasonJarvan wants to merge 1 commit into
JasonJarvan wants to merge 1 commit into
Conversation
The collab spec claimed the repo uses rebase-merge and that per-commit bodies/trailers land on main verbatim. GitHub is actually configured squash-only (rebase and merge-commit are both disabled), so a PR collapses to a single commit and per-commit trailers are lost. - state squash-merge as the integration method - make the PR-description Co-authored-by trailer a current rule, not a hypothetical future switch - reframe sync-before-push: still recommended, but rebase is not required for linearity and a plain merge is acceptable (check_commit_messages.py now runs with --no-merges) Co-authored-by: Claude (claude-opus-4-8) <noreply@anthropic.com>
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
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
The AI-collaboration spec (
AGENTS.md, whichCLAUDE.mdsymlinks to) claimed the repo uses rebase merge (not squash) and, from that, that every commit's body/trailer lands onmainverbatim. GitHub is actually configured squash-only:allow_squash_merge=true,allow_rebase_merge=false,allow_merge_commit=false. Under squash-merge a PR collapses to a single commit onmain, so per-commit trailers are lost — the exact opposite of what the spec assumed.This doc-only change corrects the merge-strategy wording so the guidance matches reality:
Co-authored-bytrailer must live in the PR description, not only a commit body.Co-authored-by: ..., else the squash commit loses the trailer.git merge origin/<target>is an acceptable alternative. Noted thatcheck_commit_messages.pynow runs with--no-merges, so a merge commit on your branch won't fail lint.No rule clauses were changed — only the merge-strategy framing.
Type
Verification
Reviewed GitHub merge settings:
gh api repos/EverMind-AI/Raven --jq '{rebase:.allow_rebase_merge,merge:.allow_merge_commit,squash:.allow_squash_merge}'returned{"rebase":false,"merge":false,"squash":true}.Confirmed
scripts/check_commit_messages.pyrunsgit log --no-merges ...(introduced in ci: skip merge commits in commit-message lint #90).grep -niE "rebase[ -]merge|verbatim" AGENTS.md— no stale wording remains.Relevant tests pass locally
Relevant lint / type checks pass locally
User-facing docs or screenshots are updated when needed
Note: docs-only change, no code paths touched, so no unit tests apply. The pre-commit hooks (including the commit-message lint) passed on commit.
Risk
Related Issues
N/A
Co-authored-by: Claude (claude-opus-4-8) noreply@anthropic.com