Skip to content

Commit c9fa1a3

Browse files
authored
[skip ci]Update CONTRIBUTING.md
1 parent e08661a commit c9fa1a3

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ To ensure robustness and reliability this repository includes a set of tests whi
3838
pytest tests
3939
```
4040

41+
### 🌿 Using the Right Branch
42+
43+
In order to fix previous versions, minor versions each have their own branch. This branch is created prior to the release of `vX.Y`. At this point there should be no new features added, with only bug fixes being applied.
44+
45+
Remember if working on a fix for a particular minor version, checkout and branch from the branch for that version, and make sure to select the appropriate version branch when opening an MR. For example a bug fix for `v1.1` made on a new branch `hotfix/fix-that-bug` created from the `v1.1` branch, would then be merged back into the `v1.1` branch.
46+
47+
Development of new features, or towards the latest version should be made on branches created from `dev` which must always contain the latest version. Such branches should, where possible, contain only a single new feature and be labelled `feature/<feature-description>`.
48+
49+
The branch `main` contains only tagged releases, the idea being all commits on this branch are usable versions.
50+
4151
### ℹ️ Typing
4252

4353
All code within this repository makes use of Python's typing capability, this has proven invaluable for spotting any incorrect usage of functionality as linters are able to quickly flag up any incompatibilities. Typing also allows us define validator rules using the [Pydantic](https://docs.pydantic.dev/latest/) framework. We ask that you type all functions and variables where possible.

0 commit comments

Comments
 (0)