Add basic development/release docs. [skip ci]

python-greenlet · Nov 16, 2020 · 34ee3cb · 34ee3cb
1 parent 1c8d50a
commit 34ee3cb
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/docs/development.rst b/docs/development.rst
@@ -0,0 +1,31 @@
+=====================
+ Development Process
+=====================
+
+This document is a collection of notes about how greenlet is
+developed.
+
+Github
+======
+
+The primary development location for greenlet is GitHub:
+https://github.com/python-greenlet/greenlet/
+
+Releases
+========
+
+greenlet uses Semantic Versions; this includes changes to the ABI
+(breaking the ABI is considered a major change).
+
+Releases are made using `zest.releaser
+<https://zestreleaser.readthedocs.io/en/latest/>`_.
+
+.. code-block::
+   :language: shell
+
+   $ pip install zest.releaser[recommended]
+   $ fullrelease
+
+Binary wheels are created and uploaded to PyPI for Windows, macOS, and
+Linux (x86_64 and aarch64) when a tag is pushed to the repository.
+The above command does this.
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,6 +18,7 @@ Contents
    api
    c_api
    changes
+   development
 
 
 .. |--| unicode:: U+2013   .. en dash