Documented the development and release models

Author: inclement

README.md

@@ -2,8 +2,8 @@ python-for-android
 ==================
 
 [![Build Status](https://travis-ci.org/kivy/python-for-android.svg?branch=master)](https://travis-ci.org/kivy/python-for-android)
-[![Backers on Open Collective](https://opencollective.com/kivy/backers/badge.svg)](#backers) 
-[![Sponsors on Open Collective](https://opencollective.com/kivy/sponsors/badge.svg)](#sponsors) 
+[![Backers on Open Collective](https://opencollective.com/kivy/backers/badge.svg)](#backers)
+[![Sponsors on Open Collective](https://opencollective.com/kivy/sponsors/badge.svg)](#sponsors)
 
 python-for-android is a packager for Python apps on Android. You can
 create your own Python distribution including the modules and
@@ -68,9 +68,16 @@ We also have [#support Discord channel](https://chat.kivy.org/).
 
 ## Contributing
 
-We love pull requests and discussing novel ideas. Check out our
-[contribution guide](http://kivy.org/docs/contribute.html) and feel
-free to improve python-for-android.
+We love pull requests and discussing novel ideas. Check out the Kivy
+project [contribution guide](http://kivy.org/docs/contribute.html) and
+feel free to improve python-for-android.
+
+python-for-android uses a [Git
+flow](https://nvie.com/posts/a-successful-git-branching-model/)
+development model. See [our
+documentation](https://python-for-android.readthedocs.io/en/latest/contribute/)
+for more details, but no need to worry about these. You just need to
+make a pull request as normal, we'll take care of the rest.
 
 The following mailing list and IRC channel are used exclusively for
 discussions about developing the Kivy framework and its sister projects:
@@ -138,4 +145,3 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 <a href="https://opencollective.com/kivy/sponsor/7/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/7/avatar.svg"></a>
 <a href="https://opencollective.com/kivy/sponsor/8/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/8/avatar.svg"></a>
 <a href="https://opencollective.com/kivy/sponsor/9/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/9/avatar.svg"></a>
-

doc/source/contribute.rst

@@ -1,8 +1,69 @@
-Contributing
-============
+Development and Contributing
+============================
 
 The development of python-for-android is managed by the Kivy team `via
 Github <https://github.com/kivy/python-for-android>`_.
 
 Issues and pull requests are welcome via the integrated `issue tracker
 <https://github.com/kivy/python-for-android/issues>`_.
+
+Read on for more information about how we manage development and
+releases, but don't worry about the details! Pull requests are welcome
+and we'll deal with the rest.
+
+Development model
+-----------------
+
+python-for-android is developed using a `Git flow model
+<https://nvie.com/posts/a-successful-git-branching-model/>`__. This means that:
+
+- The ``master`` branch always represents the latest stable release.
+- The ``develop`` branch is the most up to date with new contributions.
+
+Versioning
+----------
+
+python-for-android releases currently use `calendar versioning
+<https://calver.org/>`__. Release numbers are of the form
+YYYY.MM.DD. We aim to create a new release every four weeks, but more
+frequent releases are also possible.
+
+We use calendar versioning because in practice, changes in
+python-for-android are often driven by updates or adjustments in the
+Android build tools. It's usually best for users to be working from
+the latest release. We try to maintain backwards compatibility even
+while internals are changing.
+
+
+Creating a new release
+----------------------
+
+New releases follow these steps:
+
+- Create a new branch ``release/YYYY.MM.DD`` based on the ``develop`` branch.
+  - ``git checkout -b release/YYYY.MM.DD develop``
+- Create a Github pull request to merge ``release/YYYY.MM.DD`` into ``master``.
+- Complete all steps in the `release checklist <release_checklist_>`_,
+  and document this in the pull request (copy the checklist into the PR text)
+
+At this point, wait for reviewer approval and conclude any discussion that arises. To complete the release:
+
+- Merge the release branch to the ``master`` branch.
+- Also merge the release branch to the ``develop`` branch.
+- Tag the release commit in ``master``. Include a short summary of the changes.
+- Create the release distributions: ``python3 setup.py sdist``
+- Upload the release to pypi: ``python3 -m twine upload``.
+- Upload the release ``.tar.gz`` to the Github tag.
+
+.. _release_checklist:
+
+Release checklist
+~~~~~~~~~~~~~~~~~
+
+- [ ] Check that the [build is passing](https://travis-ci.org/kivy/python-for-android)
+- [ ] Run the tests locally via `tox`: this performs some long-running tests that are skipped on Travis.
+- [ ] Build and run the [on_device_unit_tests](https://github.com/kivy/python-for-android/tree/master/testapps/on_device_unit_tests) app using buildozer. Check that they all pass.
+- [ ] Build and run the following [testapps](https://github.com/kivy/python-for-android/tree/master/testapps) for arch `armeabi-v7a` and `arm64-v8a`:
+  - [ ] `python3 setup_testapp_python3_sqlite_openssl.py apk`
+  - [ ] `python3 setup_testapp_python2.py apk`
+- [ ] Check that the version number is correct