upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-06-04 14:26:10 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Merge pull request #296 from cooperq/restification

Browse source 
Add set up instructions to CONTRIBUTING.rst
This commit is contained in:
James Kasten 2015-03-20 17:29:43 -07:00
commit ec8f54d1ee
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.rst
View file

@ -4,14 +4,16 @@ Hacking
=======
In order to start hacking, you will first have to create a development
environment:
environment. Start by `installing dependencies and setting up Let's Encrypt`_.
Now you can install the development packages:
::
./venv/bin/python setup.py dev
The code base, including your pull requests, **must** have 100% test statement
coverage **and** be compliant with the :ref:`coding-style`.
coverage **and** be compliant with the coding-style_.
The following tools are there to help you:
@ -23,9 +25,9 @@ The following tools are there to help you:
- ``./venv/bin/tox -e lint`` checks the style of the whole project,
while ``./venv/bin/pylint --rcfile=.pylintrc file`` will check a single `file` only.
.. _installing dependencies and setting up Let's Encrypt: https://letsencrypt.readthedocs.org/en/latest/using.html
.. _coding-style:
Coding style
============