summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaphaël Barrois <raphael.barrois@polytechnique.org>2012-05-22 02:11:01 +0200
committerRaphaël Barrois <raphael.barrois@polytechnique.org>2012-05-22 02:11:01 +0200
commit467bc2449626350e4f6cac184ddda3a474282558 (patch)
tree92b01006fcff1fafcae64ec0d416101dda46b8b4
parent4691a44b37b94f36fd8e9027137065e076c3c35c (diff)
downloadsemantic-version-467bc2449626350e4f6cac184ddda3a474282558.tar.gz
Add 'contributing' doc.
Signed-off-by: Raphaël Barrois <raphael.barrois@polytechnique.org>
-rw-r--r--doc/index.rst24
1 files changed, 23 insertions, 1 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 38156cf..e916b26 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -185,6 +185,29 @@ Contents
django
changelog
+
+Contributing
+============
+
+In order to contribute to the source code:
+
+- Open an issue on `GitHub`_: https://github.com/rbarrois/python-semanticversion/issues
+- Fork the `repository <https://github.com/rbarrois/python-semanticversion>`_
+ and submit a pull request on `GitHub`_
+- Send me a patch (mailto:raphael.barrois@polytechnique.org)
+
+When submitting patches or pull requests, you should respect the following rules:
+
+- Coding conventions are based on :pep:`8`
+- The whole test suite must pass after adding the changes
+- The test coverage for a new feature must be 100%
+- New features and methods should be documented in the :doc:`reference` section
+ and included in the :doc:`changelog`
+
+.. note:: 'raw' patches / pull requests will be accepted too, but will require more
+ cooperative work to bring them to the expected standard.
+
+
Links
=====
@@ -197,7 +220,6 @@ Links
.. _SemVer: http://semver.org/
.. _PyPI: http://pypi.python.org/
-
Indices and tables
==================