Skip to content

Commit

Permalink
CONTRIBUTING.md: Update instructions
Browse files Browse the repository at this point in the history
With changing the repository structure, the 
instructions on checking codestyle and tests did
become a little less clear. 
In order to avoid confusion, we update the 
instructions with a note.
  • Loading branch information
s-heppner committed Nov 14, 2024
1 parent 0543f27 commit da7680b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ Python's builtin `unittest`. To install the required tools, use:
pip install .[dev]
```

> [!note]
> The `.` denotes the current directory and needs to be the directory the `pyproject.toml` is located in.
> Therefore, you need to run this command and the ones below in the `/sdk` directory (relative to the repository root).
Running all checks:
```bash
mypy basyx test
Expand Down

0 comments on commit da7680b

Please sign in to comment.