From 973cd6ce42b837175087f4e2a4af4f978fbe9df2 Mon Sep 17 00:00:00 2001 From: Liam Marshall Date: Mon, 5 Oct 2015 18:19:36 -0500 Subject: [PATCH 1/3] 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 ========================== From a4e5f298565e9b21c4d551bcd3122a404f3fc729 Mon Sep 17 00:00:00 2001 From: Liam Marshall Date: Mon, 5 Oct 2015 18:25:33 -0500 Subject: [PATCH 2/3] Add link to instructions for running integration tests --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index d2bb2ebd5..a76d76cd8 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -276,7 +276,7 @@ Steps: 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 `. +6. Run the integration tests, see `integration`_. 7. Submit the PR. Updating the documentation From 454a661d444dfc3e97db826159edc2b35ee820e7 Mon Sep 17 00:00:00 2001 From: Liam Marshall Date: Fri, 9 Oct 2015 15:46:03 -0500 Subject: [PATCH 3/3] contributing.rst: fix nits pointed out by @kuba --- docs/contributing.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index a76d76cd8..b4b1619ce 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -269,14 +269,19 @@ Please: 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. +2. Make sure your environment is set up properly and that you're in your + virtualenv. You can do this by running ``./bootstrap/dev/venv.sh``. + (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. Run the integration tests, see `integration`_. +5. Run ``tox`` to run the entire test suite including coverage. Fix any errors. +6. If your code touches communication with an ACME server/Boulder, you + should run the integration tests, see `integration`_. 7. Submit the PR. Updating the documentation