DOC Add documentation about repository management #487
Conversation
This file contains 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
GuySartorelli
commented
Mar 26, 2024
Comment on lines
+11
to
+34
| ### Naming convention | ||
|
|
||
| Branches with a single integer (e.g. `5`) represent either the next *major* release (if there have been no tagged releases for that release line yet) or the next *minor* release. | ||
|
|
||
| Branches with an integer, a dot, and another integer (e.g. `5.2`) represent either the *next patch release* for the current minor, or a patch release for a previous minor version. | ||
|
|
||
| > [!NOTE] | ||
| > Branches with any other naming strategy should not be the target of any pull requests. Only branches following this naming convention are included in merge-ups and are used as the base for new tagged releases. | ||
|
|
||
| For example, if we have the following tags: | ||
|
|
||
| ```text | ||
| 5.1.17 | ||
| 5.2.0 | ||
| ``` | ||
|
|
||
| Then: | ||
|
|
||
| - `5.1` is the patch release branch for the previous minor version. High severity security fixes should target this branch. | ||
| - `5.2` is the next-patch release branch for the current minor version. Bugfixes should target this branch. | ||
| - `5` is the next-minor release branch. Enhancements should target this branch. | ||
| - `6` is the next-major release branch. Changes that break backwards compatibility should target this branch. |
There was a problem hiding this comment.
This part is outside of the scope of the issue - but makes sense to document here while I'm at it.
GuySartorelli
force-pushed
the
pulls/5.2/repository-docs
branch
from
8149143 to
a5205c8
Compare
GuySartorelli
force-pushed
the
pulls/5.2/repository-docs
branch
from
a5205c8 to
02dbb32
Compare
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.
Description
Add documentation about how we manage repositories.
For now it's all about branches but other repo management docs can be added as needed.
I decided to go with a nice broad scope for the page so we have somewhere to add anything else related to repo management in the future, rather than having a page that is only about branch protection rules.
Issues
Pull request checklist