Skip to content

Commit 6425c78

Browse files
hasezoeynodkz
authored andcommitted
chore(CONTRIBUTING): add section "Branch Structure"
1 parent d7189a9 commit 6425c78

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ to read on GitHub as well as in various git tools.
2424

2525
### Revert
2626

27-
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header
27+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header
2828
of the reverted commit.
2929
In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit
3030
being reverted.
@@ -70,3 +70,19 @@ The footer should contain any information about **Breaking Changes** and is also
7070

7171
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
7272
The rest of the commit message is then used for this.
73+
74+
## Branch Structure
75+
76+
### master branch
77+
78+
The `master` branch is the release branch.
79+
80+
It has the following protection rules:
81+
82+
* `linear-history`: Requires linear-history, meaning no merge-commits
83+
* `status-checks`: All required status checks must pass before being able to merge (Currently required: `tests (12.x)`)
84+
* `branches-up-to-date`: The Branches must be up-to-date before being able to merge into `master`
85+
86+
### next branch
87+
88+
The `next` branch is the development branch, to accumulate changes before releasing an version

0 commit comments

Comments
 (0)