You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-13Lines changed: 9 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -26,24 +26,20 @@ Do you want to contribute code to `codetiming`? Fantastic! We welcome contributi
26
26
27
27
## Setting Up Your Environment
28
28
29
-
`codetiming` uses [`flit`](https://flit.readthedocs.io) for package management. You should first install `flit`:
29
+
`codetiming` uses [`flit`](https://flit.readthedocs.io) for package management. You can use `flit` through [`pip`](https://realpython.com/what-is-pip/).
30
30
31
-
```
32
-
$ python -m pip install flit
33
-
```
34
-
35
-
You can then install `codetiming` locally for development with `flit`:
31
+
You can then install `codetiming` locally for development with `pip`:
36
32
37
33
```
38
-
$ python -m flit install --pth-file --deps all
34
+
$ python -m pip install --editable .[dev,test]
39
35
```
40
36
41
-
This will install `codetiming` and all its dependencies, including development tools like [`black`](https://black.readthedocs.io) and [`mypy`](http://mypy-lang.org/). The `--pth-file` option allows you to test your changes without reinstalling. On Linux and Mac, you can use `--symlink` for the same effect.
37
+
This will install `codetiming` and all its dependencies, including development tools like [`black`](https://black.readthedocs.io) and [`mypy`](http://mypy-lang.org/), and test runners like [`pytest`](https://docs.pytest.org/). The `--editable` option allows you to test your changes without reinstalling.
42
38
43
39
44
40
## Running Tests
45
41
46
-
Run tests using [`tox`](https://tox.readthedocs.io/). `tox` helps to enforce the following principles:
42
+
Run tests using [`tox`](https://tox.readthedocs.io/). You can also run individual tests manually. `tox` helps to enforce the following principles:
47
43
48
44
- Consistent code style using [`black`](https://black.readthedocs.io). You can automatically format your code as follows:
49
45
@@ -62,10 +58,10 @@ Run tests using [`tox`](https://tox.readthedocs.io/). `tox` helps to enforce the
62
58
- Unit testing using [`pytest`](https://docs.pytest.org/). You can run your tests and see a coverage report as follows:
- Code issues are checked with the [flake8]() linter. You can run flake8 manually as follows:
64
+
- Code issues are checked with the [flake8](https://flake8.pycqa.org/) linter. You can run flake8 manually as follows:
69
65
70
66
```console
71
67
$ python -m flake8 codetiming/ tests/
@@ -80,7 +76,7 @@ Run tests using [`tox`](https://tox.readthedocs.io/). `tox` helps to enforce the
80
76
- All modules, functions, classes, and methods must have docstrings. This is enforced by [Interrogation](https://interrogate.readthedocs.io/). You can test compliance as follows:
81
77
82
78
```console
83
-
$ interrogate -c pyproject.toml -vv
79
+
$ python -m interrogate -c pyproject.toml -vv
84
80
```
85
81
86
-
Feel free to ask for help in your PR if you are having challenges with any of these tests.
82
+
Feel free to ask for help in your PR if you are having challenges with any of these tests.
0 commit comments