upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-06-09 00:32:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

contributing.rst: fix nits pointed out by @kuba

Browse source
This commit is contained in:
Liam Marshall 2015-10-09 15:46:03 -05:00
parent a4e5f29856
commit 454a661d44
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/contributing.rst
View file

@ -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