diff --git a/.gitignore b/.gitignore index e1dca3a57..f2cec0721 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ venv/ .tox/ .coverage m3 +*.swp diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9cb73a654..bfd0a1c0f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 ============