From 973cd6ce42b837175087f4e2a4af4f978fbe9df2 Mon Sep 17 00:00:00 2001 From: Liam Marshall Date: Mon, 5 Oct 2015 18:19:36 -0500 Subject: [PATCH] Add instructions for submitting a PR. --- docs/contributing.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 3959ccee1..d2bb2ebd5 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -267,6 +267,17 @@ Please: .. _PEP 8 - Style Guide for Python Code: https://www.python.org/dev/peps/pep-0008 +Submitting a pull request +========================= +Steps: + +1. Write your code! +2. Make sure your environment is set up properly and that you're in your virtualenv (this is a **very important** step). +3. Run ``./pep8.travis.sh`` to do a cursory check of your code style. Fix any errors. +4. Run ``tox -e lint`` to check for pylint errors. Fix any errors. +5. Run ``tox`` to run the unit tests. Fix any errors. +6. :ref:`Run the integration tests `. +7. Submit the PR. Updating the documentation ==========================