Skip to content
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.

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

WIP: Document dev branches #6067

Closed
wants to merge 2 commits into from

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jul 16, 2024

Which issue does this PR close?

Related to #6050
Related to #6016

Rationale for this change

We ended up with many PRs stacked up waiting to merge to main that could not because they had breaking changes (see discussion on #6050)

For 53.0.0 we tried making a feature branch, 53.0.0-dev, to collect PRs with breaking changes before master opens.

This PR documents how that worked

I plan to update it as we

What changes are included in this PR?

Update CONTRIBUTING.md document

Are there any user-facing changes?

Docs

Comment on lines +131 to +135
Our [release schedule] allows breaking API changes only in major releases. This
means that if your PR has a breaking API change, it should be marked with the
labels: `api-change` and `next-major-release` and it will not be merged to
`master` until development opens for the next major release. See [this ticket] for
details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think contributors can set labels. You'll need to configure a bot to set the label based on the target branch.

@alamb alamb marked this pull request as draft August 6, 2024 14:25
@alamb
Copy link
Contributor Author

alamb commented Aug 6, 2024

I am not sure how great this idea was - so marking this as draft until we may need to do it again

@tustvold
Copy link
Contributor

tustvold commented Oct 8, 2024

Should we close this?

@alamb
Copy link
Contributor Author

alamb commented Oct 9, 2024

Should we close this?

Yeah, I think we can reopen/ revive it if we want to do a dev branch again. I would say it was non ideal and going with the 'deprecate and make new APIs' was better

@alamb alamb closed this Oct 9, 2024
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.

3 participants