docs(branching): add branching strategy and update CONTRIBUTING#208
Open
parth0025 wants to merge 1 commit into
Open
docs(branching): add branching strategy and update CONTRIBUTING#208parth0025 wants to merge 1 commit into
parth0025 wants to merge 1 commit into
Conversation
- New BRANCHING.md documenting the two-branch model (main + staging), 11 topic-branch types, PR/hotfix/release workflows, protected branch rules, and ready-to-run gh api commands for enabling them - Fix CONTRIBUTING.md base branch (main -> staging) and update branch naming examples to Conventional-Commits style - Add BRANCHING.md to .claude/REFERENCES.md docs index Step 2 of the open-source repo maintenance baseline initiative. Branch protection rules are documented in BRANCHING.md but NOT applied to GitHub yet β they will be enabled after this PR merges to avoid blocking the very PR that introduces them. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the βοΈ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
β¨ Finishing Touchesπ§ͺ Generate unit tests (beta)
Comment |
7 tasks
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
Adds BRANCHING.md β a comprehensive branching-strategy doc that captures AlianHub's two-branch model (
main+staging) and alignsCONTRIBUTING.mdwith reality (it previously told contributors to branch offmain, but we've been branching offstagingall along).Step 2 of the open-source repo maintenance baseline initiative (Step 1 β license relicense to AGPL-3.0).
Why this matters
Right now, a new contributor reading
CONTRIBUTING.mdwould create a branch offmainand open a PR againstmain. That PR would either be wildly out of date (staging is 235 commits ahead) or rejected. This PR fixes that gap and gives contributors a single source of truth for branch conventions.Files changed (3)
BRANCHING.md(new, 327 lines)CONTRIBUTING.mdmainβstaging), updated branch naming examples to Conventional-Commits style (feature/βfeat/, etc.), added link to BRANCHING.md.claude/REFERENCES.mdThe model (captured, not invented)
Model choices documented (reviewers β push back if any feel wrong)
mainPRsmainstagingPRsBranch protection rules are documented but NOT yet applied to GitHub. The ready-to-run
gh apicommands are in BRANCHING.md Β§ How to enable branch protection.We will run those commands after this PR merges β applying them now would block the very PR that introduces them.
Test plan
#topic-branches,#how-to-enable-branch-protection-one-time-setup) workmainas the base branch.claude/REFERENCES.mdβ BRANCHING.md worksAfter merge
gh apibranch-protection commands from BRANCHING.md (admin-only)π€ Generated with Claude Code