Skip to content

Commit d6da935

Browse files
authored
update installation instructions for contributors (#10)
* update installation instructions for contributors * lint
1 parent 72c803e commit d6da935

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,20 @@ without further discussion. If you planning to contribute new features, please o
88
`issue <https://github.com/pmeier/light-the-torch/issues>`_
99
and discuss the feature with us first.
1010

11-
Every PR is subjected to multiple checks that it has to pass before it can be merged.
12-
The checks are performed by `tox <https://tox.readthedocs.io/en/latest/>`_ . You can
13-
install it alongside all other development requirements with
11+
To start working on ``light-the-torch`` clone from the latest version and install the
12+
development requirements:
1413

1514
.. code-block:: sh
1615
16+
LIGHT_THE_TORCH_ROOT = light-the-torch
17+
git clone https://github.com/pmeier/light-the-torch $LIGHT_THE_TORCH_ROOT
1718
cd $LIGHT_THE_TORCH_ROOT
1819
pip install -r requirements-dev.txt
20+
pre-commit install
1921
20-
Below you can find details and instructions how to run the checks locally.
21-
22+
Every PR is subjected to multiple checks that it has to pass before it can be merged.
23+
The checks are performed by `tox <https://tox.readthedocs.io/en/latest/>`_ . Below
24+
you can find details and instructions how to run the checks locally.
2225

2326
Code format and linting
2427
-----------------------
@@ -28,8 +31,9 @@ imports, `black <https://black.readthedocs.io/en/stable/>`_ to format the code,
2831
`flake8 <https://flake8.pycqa.org/en/latest/>`_ to enforce
2932
`PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ compliance.
3033

31-
Furthermore, ``light-the-torch`` is `PEP561 <https://www.python.org/dev/peps/pep-0561/>`_
32-
compliant and checks the type annotations with `mypy <http://mypy-lang.org/>`_ .
34+
Furthermore, ``light-the-torch`` is
35+
`PEP561 <https://www.python.org/dev/peps/pep-0561/>`_ compliant and checks the type
36+
annotations with `mypy <http://mypy-lang.org/>`_ .
3337

3438
To format your code run
3539

@@ -40,14 +44,8 @@ To format your code run
4044
4145
.. note::
4246

43-
The formatting with ``isort``, ``black``, as well as other minor utilities can be
44-
performed by `pre-commit <https://pre-commit.com/>`_ before every commit.
45-
``pre-commit`` is installed as development requirement. To enable this behavior run
46-
47-
.. code-block:: sh
48-
49-
cd $LIGHT_THE_TORCH_ROOT
50-
pre-commit install
47+
Amongst others, ``isort`` and ``black`` are run by
48+
`pre-commit <https://pre-commit.com/>`_ before every commit.
5149

5250
To run the full lint check locally run
5351

0 commit comments

Comments
 (0)