update Development section of doc.

jazzband · Jul 28, 2018 · 6d3a969 · 6d3a969
1 parent 3595009
commit 6d3a969
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 13 deletions.
diff --git a/checklist.rst b/checklist.rst
@@ -1,12 +1,19 @@
-ToDo for releasing
-=====================
+.. release procedure
 
-1. check travis-ci testing result
+Prepare newest packages:
+
+* setuptools
+* wheel
+* twine
+
+Procedure:
+
+1. check travis-ci testing result: https://travis-ci.org/shimizukawa/django-redshift-backend
 2. check release version in ``setup.py`` and ``CHANGES.rst``
 3. build distribtion files: ``python setup.py release sdist bdist_wheel``
 4. make a test release: ``twine upload --repository-url https://test.pypi.org/legacy dist/<new-version-files>``
 5. make a release: ``twine upload dist/<new-version-files>``
 6. check PyPI page: https://pypi.org/p/django-redshift-backend
 7. tagging with version name. e.g.: git tag 0.4
-8. bump version in setup.py and README.rst
+8. bump version in setup.py and README.rst and commit/push them onto GitHub
 
diff --git a/doc/dev.rst b/doc/dev.rst
@@ -2,20 +2,35 @@
 Development
 ===========
 
+Issue Reporting
+===============
+
+**To Be Written**
+
+* https://github.com/shimizukawa/django-redshift-backend/issues
+
 Testing
 =======
 
-Testing this package requires:
+Install these packages before testing:
 
 * tox-1.8 or later
 * virtualenv-15.0.1 or later
-* pip-8.1.1 or later
+* pip-10.0.3 or later
 
+Run test
+--------
 
-CI
----
+Just run tox::
 
-**To Be Written**
+   $ tox
+
+tox have several sections for testing.
+
+CI (Continuous Integration)
+----------------------------
+
+All tests will be run on Travis CI service.
 
 * https://travis-ci.org/shimizukawa/django-redshift-backend
 
@@ -28,10 +43,21 @@ Pull Request
 * https://github.com/shimizukawa/django-redshift-backend/pulls
 
 
-Issue Reporting
-===============
+Releasing
+=========
 
-**To Be Written**
+New package version
+-------------------
+
+The django-redshift-backend package will be uploaded to PyPI: https://pypi.org/project/django-redshift-backend/.
+
+Here is a release procefure for releasing.
+
+.. include:: ../checklist.rst
+
+
+Updated documentation
+---------------------
 
-https://github.com/shimizukawa/django-redshift-backend/issues
+Sphinx documentation under ``doc/`` directory on the master branch will be automatically uploaded into ReadTheDocs: http://django-redshift-backend.rtfd.io/.