Merge pull request #56 from metacloud/development

Added development documentation

doc/source/changelog.rst

@@ -1 +1,3 @@
+.. _changelog:
+
 .. include:: ../../CHANGELOG.rst

doc/source/contributing.rst

@@ -1 +1,3 @@
+.. _contributing:
+
 .. include:: ../../CONTRIBUTING.rst

doc/source/development.rst

@@ -0,0 +1,68 @@
+***********
+Development
+***********
+
+* Please read the :ref:`contributing` guidelines.
+
+Branches
+========
+
+* The ``master`` branch is stable.  Major changes should be performed
+  elsewhere.
+
+Release Engineering
+===================
+
+Pre-release
+-----------
+
+* Edit the :ref:`changelog`.
+* Follow the :ref:`testing` steps.
+
+Release
+-------
+
+Gilt follows `Semantic Versioning`_.
+
+.. _`Semantic Versioning`: http://semver.org
+
+Tag the release and push to github.com
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    $ git tag 2.0.0
+    $ git push --tags
+
+Upload to `PyPI`_
+^^^^^^^^^^^^^^^^^
+
+* Install `Twine`_ using `pip`.
+
+    .. code-block:: bash
+
+        $ pip install twine
+
+* Upload to  `PyPI`_.
+
+    .. code-block:: bash
+
+        $ cd /path/to/gilt
+        $ rm -rf build/ dist/
+        $ python setup.py sdist bdist_wheel
+        $ twine upload dist/*
+        $ rm -rf build/ dist/
+
+Post-release
+------------
+
+* Comment/close any relevant `Issues`_.
+
+Roadmap
+=======
+
+* See `Issues`_ on Github.com.
+
+.. _`PyPI`: https://pypi.python.org/pypi/python-gilt
+.. _`ISSUES`: https://github.com/metacloud/gilt/issues
+.. _`Twine`: https://pypi.python.org/pypi/twine

doc/source/index.rst

@@ -105,13 +105,6 @@ Integrates with `Molecule`_ as an `Ansible Galaxy`_ CLI replacement.  Update
       name: shell
       command: gilt overlay
 
-Testing
-=======
-
-.. code-block:: bash
-
-    $ pip install tox
-    $ tox
 
 Similar Tools
 =============
@@ -121,7 +114,9 @@ Similar Tools
 .. toctree::
    :maxdepth: 3
 
+   testing
    contributing
+   development
    changelog
    authors
    autodoc

doc/source/testing.rst

@@ -0,0 +1,9 @@
+.. _testing:
+
+Testing
+=======
+
+.. code-block:: bash
+
+    $ pip install tox
+    $ tox