-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC Add documentation about repository management
- Loading branch information
1 parent
c8bd64f
commit 8149143
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: GitHub repository management | ||
summary: Information about management of the various GitHub repositories | ||
iconBrand: github | ||
--- | ||
|
||
# GitHub repository management | ||
|
||
## Branches | ||
|
||
### 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. | ||
|
||
### Branch protection | ||
|