Skip to content

Commit c1ebd62

Browse files
authored
CONTRIBUTING.md: Add branching policy
1 parent 53db026 commit c1ebd62

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

CONTRIBUTING.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,18 @@ $ poetry install -E docs
8484
$ poetry run sphinx-build -b html docs docs\_build
8585
```
8686

87+
# Branching Policy
88+
89+
Active development for the next release occurs on the `master` branch.
90+
91+
During finalization, we create a release branch (e.g. `releases/1.2`) in order to control which changes target the imminent
92+
release vs. the next release after that. Changes that are intended for both the imminent release and subsequent releases
93+
should be made in the `master` branch and cherry-picked into the release branch. Changes that only apply to the imminent
94+
release (such as version numbers) may be made directly in the release branch.
95+
8796
# Release Process
8897

89-
1. Ensure your git `HEAD` is at the latest version of `master` branch with no pending changes.
98+
1. Ensure your git `HEAD` is at the latest version of the `master` or appropriate `releases/*` branch with no pending changes.
9099
2. Note the version currently being released by running:
91100
```sh
92101
$ poetry version

0 commit comments

Comments
 (0)