From 32786802b044a8f12895561b87c1cf826b003f2a Mon Sep 17 00:00:00 2001
From: Eeshan Garg <jerryguitarist@gmail.com>
Date: Thu, 1 Jun 2017 21:20:18 -0230
Subject: [PATCH] docs: Document the release process for the Zulip API PyPI
 package.

---
 docs/api-release-checklist.md | 43 +++++++++++++++++++++++++++++++++++
 docs/index.rst                |  1 +
 2 files changed, 44 insertions(+)
 create mode 100644 docs/api-release-checklist.md

diff --git a/docs/api-release-checklist.md b/docs/api-release-checklist.md
new file mode 100644
index 0000000000..9dbc5d45b0
--- /dev/null
+++ b/docs/api-release-checklist.md
@@ -0,0 +1,43 @@
+# Zulip PyPI package release checklist
+
+This document describes the steps to be followed when preparing
+a new release of the
+[PyPI package for our API bindings][1].
+
+While performing the steps outlined below, we should adhere to
+the guidelines presented in the
+[Python Packaging User Guide](https://packaging.python.org/).
+
+The steps below assume that you are familiar with the material
+presented [here](https://packaging.python.org/installing/).
+
+1. [Reconfigure the package][2], if need be (upgrade version
+  number, development status, and so on).
+
+2. Create a [source distribution][3].
+
+3. Create a [pure Python Wheel][4].
+
+4. [Upload][5] the distribution file(s) to [zulip-beta][6].
+
+5. Post about the beta release in `#general` and test
+   the [zulip-beta][6] package extensively.
+
+6. Respond to the feedback received in **Step 5**.
+
+7. Make final changes, upload the distribution file(s) to the
+   main [zulip][1] package.
+
+8. Post in `#general` about the new release.
+
+**Note:** We may upload directly to the main [zulip][1] package
+without beta-testing on [zulip-beta][6], if we feel that the changes
+made in the new release are minor and not disruptive enough to
+warrant extensive pretesting.
+
+[1]: https://pypi.python.org/pypi/zulip/0.3.1
+[2]: https://packaging.python.org/distributing/#configuring-your-project
+[3]: https://packaging.python.org/distributing/#source-distributions
+[4]: https://packaging.python.org/distributing/#pure-python-wheels
+[5]: https://packaging.python.org/distributing/#upload-your-distributions
+[6]: https://pypi.python.org/pypi/zulip-beta/0.2.5
diff --git a/docs/index.rst b/docs/index.rst
index 73a4974ed1..39ed528fff 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -137,5 +137,6 @@ Contents:
    client
    logging
    release-checklist
+   api-release-checklist
    README
    user-docs