Skip to content

docs: route breaking changes and major features to a dev branch#1522

Merged
kixelated merged 1 commit into
mainfrom
claude/kind-newton-41a537
May 28, 2026
Merged

docs: route breaking changes and major features to a dev branch#1522
kixelated merged 1 commit into
mainfrom
claude/kind-newton-41a537

Conversation

@kixelated
Copy link
Copy Markdown
Collaborator

Summary

  • Add a Branch Targeting section to CLAUDE.md describing when contributors should base PRs on main (stable: bug fixes, small additive changes, docs, behavior-preserving refactors) vs the new dev branch (wire-protocol changes, breaking API changes in FFI / libmoq / moq-net / hang / language wrappers, catalog/container format changes, major features that need to settle).
  • Insert a step 1 in the Workflow checklist so contributors pick a base branch before they start.
  • origin/dev has been (re-)created from origin/main to host this staging branch.

Why

We want a place to land disruptive work in batches without holding up small PRs against main, and without each disruptive PR sitting open on main for a long review cycle.

CI

No workflow changes are needed. Every pull_request: trigger in .github/workflows/ (check.yml, moq-relay.yml, moq-cli.yml, moq-token-cli.yml, libmoq.yml, check-swift.yml) is configured without a branches: filter, so PRs targeting dev already run the same CI as PRs targeting main. The only branch-scoped triggers are push: branches: [main] on release-rs.yml and release-js.yml (release-plz), which intentionally stay scoped to main.

Test plan

  • Open a throwaway PR against dev and confirm check, path-filtered Rust workflows, and check-swift all fire as expected.
  • Confirm release-rs.yml / release-js.yml do not fire on pushes to dev.

(Written by Claude)

Add a Branch Targeting section explaining when to base a PR on `main`
vs `dev`, and note that CI already runs on PRs against either branch
(no workflow changes needed since `pull_request:` triggers have no
`branches:` filter).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e61b0ab7-c381-4571-bc12-31245af36a9c

📥 Commits

Reviewing files that changed from the base of the PR and between efbe468 and ce4ebaf.

📒 Files selected for processing (1)
  • CLAUDE.md

Walkthrough

This PR updates CLAUDE.md documentation to enhance contributor guidance. A new "Branch Targeting" section was added to clarify which branch (main vs dev) should be targeted based on the type and scope of changes, with specific guidance for wire-protocol, breaking public API, and media format changes. The "Workflow" section was simultaneously revised to include base branch selection as an initial prerequisite step and expanded the checklist from 6 to 7 steps to accommodate the new guideline.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding guidance to route breaking changes and major features to a dev branch instead of main.
Description check ✅ Passed The description is directly related to the changeset, providing clear context about branch targeting guidelines, workflow changes, CI implications, and testing plans.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch claude/kind-newton-41a537

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@kixelated kixelated merged commit d55d11e into main May 28, 2026
1 check passed
@kixelated kixelated deleted the claude/kind-newton-41a537 branch May 28, 2026 16:21
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.

1 participant