Skip to content

Commit 5a25f5a

Browse files
committed
Add a contributing.rst document stub to describe precommit and general workflow
1 parent 98e01ab commit 5a25f5a

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

CONTRIBUTING.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
============================
2+
Contribution getting started
3+
============================
4+
5+
Contributions are highly welcomed and appreciated. Every little bit of help counts,
6+
so do not hesitate!
7+
8+
.. contents::
9+
:depth: 2
10+
:backlinks: none
11+
12+
13+
Preparing Pull Requests
14+
-----------------------
15+
16+
#. Fork the repository.
17+
18+
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed::
19+
20+
$ pip install --user pre-commit
21+
$ pre-commit install
22+
23+
Afterwards ``pre-commit`` will run whenever you commit.
24+
25+
https://pre-commit.com/ is a framework for managing and maintaining multi-language pre-commit hooks
26+
to ensure code-style and code formatting is consistent.
27+
28+
#. Install `tox <https://tox.readthedocs.io/en/latest/>`_::
29+
30+
Tox is used to run all the tests and will automatically setup virtualenvs
31+
to run the tests in.
32+
(will implicitly use http://www.virtualenv.org/en/latest/)::
33+
34+
$ pip install tox
35+
$ tox -e linting,py37
36+
37+
#. Follow **PEP-8** for naming and `black <https://github.com/psf/black>`_ for formatting.
38+
39+
#. Add a line item to the current **unreleased** verrsion in ``CHANGES.rst``, unless the change is trivial.

0 commit comments

Comments
 (0)