add DEVELOPMENT.md

pyTooling · Nov 30, 2021 · 9c0c508 · 9c0c508
2 parents 11ce447 + 7803d6e
commit 9c0c508
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -0,0 +1,22 @@
+# Development
+
+## Tagging/versioning
+
+See context in [#5](https://github.com/pyTooling/Actions/issues/5).
+
+Tag new releases in the `main` branch using a semver compatible value, starting with `v`:
+
+```sh
+git checkout main
+git tag v0.0.0
+git push upstream v0.0.0
+```
+
+Move the corresponding release branch (starting with `r`) forward by creating a merge commit, and using the merged tag
+as the commit message:
+
+```sh
+git checkout r0
+git merge --no-ff -m 'v0.0.0' v0.0.0
+git push upstream r0
+```