Added docs on how to contribute

aio-libs · Oct 14, 2016 · fb65ca8 · fb65ca8
1 parent a20aae8
commit fb65ca8
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,11 @@
+Contributing
+============
+
+Workflow is the following:
+
+#. Clone the repository
+#. Install dependencies with ``pip install -r requirements-ci.txt && pip install -r requirements-dev.txt``
+#. Make a change (means writing code, tests and docs)
+#. Ensure all tests pass with ``make test``
+#. Ensure documentation is OK with ``sphinx-autobuild docs/ docs/_build/html/``
+#. Make the PR in Github (you must have a fork of your own)