kgess-mirror/python-ovh
1
0
Fork 0
mirror of https://github.com/ovh/python-ovh.git synced 2026-01-16 23:00:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improv contributing guide (#26)

Browse source 
Signed-off-by: Jean-Tiare Le Bigot <jean-tiare.le-bigot@corp.ovh.com>
This commit is contained in:
Jean-Tiare Le Bigot 2016-05-26 14:48:12 +02:00
parent 6e91265c06
commit 31100b28a5
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.rst
View file

@ -5,8 +5,8 @@ This project accepts contributions. In order to contribute, you should
pay attention to a few things:
1. your code must follow the coding style rules
2. your code must be fully (100% coverage) unit-tested
3. your code must be fully documented
2. your code must be unit-tested
3. your code must be documented
4. your work must be signed
5. the format of the submission must be email patches or GitHub Pull Requests
@ -14,12 +14,11 @@ pay attention to a few things:
Coding and documentation Style:
-------------------------------
- The coding style follows `PEP-8: Style Guide for Python Code <http://wwww.python.org/dev/peps/pep-0008/>`_
- The coding style follows `PEP-8: Style Guide for Python Code <http://www.python.org/dev/peps/pep-0008/>`_ (~100 chars/lines is a good limit)
- The documentation style follows `PEP-257: Docstring Conventions <http://www.python.org/dev/peps/pep-0257/>`_
A good practice is to frequently run you code through `pylint
<http://www.pylint.org/>`_
and make sure the code grades ``10.0``.
A good practice is to frequently run you code through `pylint <http://www.pylint.org/>`_
and make sure the code grades does not decrease.
Submitting Modifications:
-------------------------