add release process to docs

jacalata · jacalata · commit 6177826a22b8 · 2021-12-16T01:11:23.000-08:00
diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md
@@ -56,3 +56,12 @@ For all other things, please submit a PR that includes the fix, documentation, o
 If the feature is complex or has multiple solutions that could be equally appropriate approaches, it would be helpful to file an issue to discuss the
 design trade-offs of each solution before implementing, to allow us to collectively arrive at the best solution, which most likely exists in the middle
 somewhere.
+
+
+## Release process
+
+We expect that everything merged into the development branch is ready to release on master. Releases can be made at any time - ideally it would be on a regular cadence but currently it is basically on request.
+- bump the version in setup.py
+- update the changelog: all commits to development should contain a meaningful message, the changelog can be built from these
+- merge to master. 
+This kicks off an automated release in github and then publish to pypi. 
