upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-04-15 22:20:28 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add instructions for submitting a PR.

Browse source
This commit is contained in:
Liam Marshall 2015-10-05 18:19:36 -05:00
parent 410f9bf383
commit 973cd6ce42
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/contributing.rst
View file

@ -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 <integration>`.
7. Submit the PR.
Updating the documentation
==========================