Skip to content

Commit 780c94f

Browse files
committed
[issue-558] add installation group for development
Signed-off-by: Meret Behrens <[email protected]>
1 parent d17188d commit 780c94f

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,10 @@ Here's the process to make changes to the codebase:
3434
git checkout -b fix-or-improve-something
3535
python -m venv ./venv
3636
./venv/bin/activate
37-
pip install -e .
37+
pip install -e ".[development]"
3838
```
39+
Note: By using the group `[development]` for the installation, all dependencies (including optional ones) will be
40+
installed. This way we make sure that all tests are executed.
3941
5. Make some changes and commit them to the branch:
4042
```sh
4143
git commit --signoff -m 'description of my changes'
@@ -49,14 +51,12 @@ Here's the process to make changes to the codebase:
4951
retroactively signs a range of past commits.
5052
6. Test your changes:
5153
```sh
52-
pip install pytest
5354
pytest -vvs # in the repo root
5455
```
5556

5657
7. Check your code style. When opening a pull request, your changes will automatically be checked with `isort`, `black`
5758
and `flake8` to make sure your changes fit with the rest of the code style.
5859
```sh
59-
pip install .[code_style]
6060
# run the following commands in the repo root
6161
isort src tests
6262
black src tests

pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ dynamic = ["version"]
3131
test = ["pytest"]
3232
code_style = ["isort", "black", "flake8"]
3333
graph_generation = ["pygraphviz", "networkx"]
34+
development = ["black", "flake8", "isort", "networkx", "pytest"]
3435

3536
[project.scripts]
3637
pyspdxtools = "spdx.clitools.pyspdxtools:main"

0 commit comments

Comments
 (0)