Skip to content

docs: correct merge-policy to match squash-only config#96

Merged
0xKT merged 1 commit into
mainfrom
docs/fix_merge_policy_in_agents_md
Jul 7, 2026
Merged

docs: correct merge-policy to match squash-only config#96
0xKT merged 1 commit into
mainfrom
docs/fix_merge_policy_in_agents_md

Conversation

@0xKT

@0xKT 0xKT commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

AGENTS.md described the repo as rebase-merge, but it is configured squash-only (squash_merge_commit_message=PR_BODY; rebase and merge-commit disabled). Correct 3.3, 3.5, and 3.7 to the real policy: rebase only freshens the branch before push, squash on merge; the squash commit body comes from the PR description (commit bodies are dropped), and GitHub auto-collects each commit's Co-authored-by -- so keep the trailer in the commit and put Closes / reviewer context in the PR description.

Type

  • Docs

Verification

Docs-only. Policy verified against gh api repos/EverMind-AI/Raven (squash-only, PR_BODY) and as observed on the #95 squash commit.

  • User-facing docs or screenshots are updated when needed

Risk

Docs-only; no code or behavior change.

Related Issues

N/A

AGENTS.md described the repo as rebase-merge, but it is configured
squash-only (squash_merge_commit_message=PR_BODY; rebase and merge-commit
disabled). Fix 3.3, 3.5, and 3.7 to state the real policy: rebase only to
freshen the branch before push, squash on merge. The squash commit body
comes from the PR description and individual commit bodies are dropped,
while GitHub auto-collects each commit's Co-authored-by -- so put Closes
and reviewer context in the PR description, and keep the trailer in the
commit (adding it to the PR description would duplicate it).

Co-authored-by: Claude (claude-opus-4-8) <noreply@anthropic.com>
@0xKT
0xKT requested a review from cyfyifanchen July 7, 2026 07:52
@0xKT
0xKT merged commit 9d7c74e into main Jul 7, 2026
7 checks passed
@0xKT
0xKT deleted the docs/fix_merge_policy_in_agents_md branch July 7, 2026 08:01
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.

2 participants