Skip to content

Clarify release merge strategy #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmorse merged 1 commit into from
Jun 13, 2026
Merged

Clarify release merge strategy #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,13 @@ Release PR flow:
5. Merge only when the release commit is green and approved.
6. Tag and publish from `main`.

Prefer squash merges for feature and fix branches unless the branch history is
intentionally structured and useful to keep.
Prefer squash merges for short-lived feature, fix, docs, and chore branches
that target `develop`, unless the branch history is intentionally structured
and useful to keep.

Do not squash release PRs or direct `develop` -> `main` promotion PRs. Use a
normal merge commit so `main` and `develop` keep a clean ancestry relationship
and can be merged back together without duplicating equivalent changes.

## Quality Gates

Expand Down Expand Up @@ -142,7 +147,8 @@ The release sequence is:
3. Bump versions and update release documentation.
4. Open a release PR into `main`.
5. Run the publishing guide checklist.
6. Merge the release PR into `main`.
6. Merge the release PR into `main` with a normal merge commit, not a squash
merge.
7. Tag the release commit on `main`.
8. Publish `whisper-cpp-plus-sys` first.
9. Wait for the crates.io index to show the sys crate.
Expand Down
Loading