docs(claude): fix stale branch-target guidance in ship-a-feature-branch#435
Open
davion-knight wants to merge 1 commit into
Open
docs(claude): fix stale branch-target guidance in ship-a-feature-branch#435davion-knight wants to merge 1 commit into
davion-knight wants to merge 1 commit into
Conversation
CLAUDE.md's "ship a feature branch" section told agents to fetch and branch off origin/main. CONTRIBUTING.md's current policy (introduced 2026-07-06) is to base feature branches on test and target test in the pr -- main is reserved for docs-only changes, promoted from test by the maintainer. CLAUDE.md predates that policy (written 2026-06-16) and was never updated, so any agent following it verbatim opens a pr against the wrong base branch, which this repo's own data shows is the single most common reason a pr gets auto-closed.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe pull request updates CLAUDE.md's "Ship a feature branch" instructions, changing the git fetch and switch commands to base new feature branches on origin/test instead of origin/main, with an accompanying note distinguishing integration branching from docs-only branching off main. ChangesDocumentation update
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
what changed
CLAUDE.md's "ship a feature branch" section instructed fetching and branching off
origin/main. CONTRIBUTING.md's current policy is to base feature branches ontestand targettestin the PR —mainis reserved for docs-only changes, promoted fromtestby the maintainer.why
CLAUDE.md's branch instructions were written 2026-06-16, before CONTRIBUTING.md's test-branch policy was introduced on 2026-07-06, and were never updated to match. Since CLAUDE.md is read automatically by Claude Code (and similar coding agents) working on this repo, any agent following it verbatim opens a PR against the wrong base branch. Wrong base branch is this repo's single most common reason a PR gets auto-closed even after a favorable review — worth fixing at the source.
validation
docs-only change, no code touched. reviewed the diff for accuracy against the current CONTRIBUTING.md wording.
Summary by CodeRabbit
testas the base branch instead ofmain.origin/test.testis the integration branch, while keeping the separate note for docs-only branches frommain.