Skip to content

Commit

Permalink
[issue-558] add installation group for development
Browse files Browse the repository at this point in the history
Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>
  • Loading branch information
meretp committed Apr 12, 2023
1 parent d17188d commit 780c94f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@ Here's the process to make changes to the codebase:
git checkout -b fix-or-improve-something
python -m venv ./venv
./venv/bin/activate
pip install -e .
pip install -e ".[development]"
```
Note: By using the group `[development]` for the installation, all dependencies (including optional ones) will be
installed. This way we make sure that all tests are executed.
5. Make some changes and commit them to the branch:
```sh
git commit --signoff -m 'description of my changes'
Expand All @@ -49,14 +51,12 @@ Here's the process to make changes to the codebase:
retroactively signs a range of past commits.
6. Test your changes:
```sh
pip install pytest
pytest -vvs # in the repo root
```

7. Check your code style. When opening a pull request, your changes will automatically be checked with `isort`, `black`
and `flake8` to make sure your changes fit with the rest of the code style.
```sh
pip install .[code_style]
# run the following commands in the repo root
isort src tests
black src tests
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ dynamic = ["version"]
test = ["pytest"]
code_style = ["isort", "black", "flake8"]
graph_generation = ["pygraphviz", "networkx"]
development = ["black", "flake8", "isort", "networkx", "pytest"]

[project.scripts]
pyspdxtools = "spdx.clitools.pyspdxtools:main"
Expand Down

0 comments on commit 780c94f

Please sign in to comment.