Skip to content

Commit 4958a6e

Browse files
committed
docs: release flow and conventional commits
1 parent 807663d commit 4958a6e

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ understand is that:
4646

4747
**pull requests need to be made against the `develop` branch**!
4848

49+
### Conventionall Commits
50+
51+
We strictly use [connventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)!
52+
4953
### Contributor License Agreement
5054

5155
Upon submission of a pull request, you will be asked to sign the
@@ -163,19 +167,6 @@ Any maintainer is allowed to merge a PR if all of these conditions are met.
163167

164168
### 9. Shipping a release (maintainers only)
165169

166-
Maintainers need to do the following to push out a release:
167-
168-
git checkout develop
169-
git fetch origin
170-
git rebase origin/develop
171-
# get latest tag
172-
git tag -l
173-
# git flow
174-
git flow release start x.y.z
175-
# bump version in setup.py
176-
git add setup.py; git commit -m "version bump"
177-
git flow release finish
178-
179-
Bundling and pushing the release:
180-
181-
make release
170+
Create a new pull request with `release/<YYYYmmdd>`. Push the branch.
171+
When merged into master, release tagging and publishing will be triggered
172+
throught github actions.

0 commit comments

Comments
 (0)