Skip to content

Commit 6efa46e

Browse files
docs: Explain how to run tests in CONTRIBUTING.md
Signed-off-by: Abdur-Rahmaan Janhangeer <cryptolabour@gmail.com> Co-authored-by: Matt Wozniski <godlygeek@gmail.com>
1 parent 8e24ba7 commit 6efa46e

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,21 @@ Changes should always include tests. If this is a bug fix it is a good idea to a
9191
first commit of the pull request and the changes to fix the issue in subsequent commits to make it
9292
easier to validate it.
9393

94+
### Running tests before submitting pull request
95+
96+
To run local tests, first install the test requirements:
97+
98+
```shell
99+
python3 -m pip install --upgrade pip
100+
python3 -m pip install -e . --group test
101+
```
102+
103+
Then, run the check:
104+
105+
```shell
106+
make check
107+
```
108+
94109
## Pull requests
95110

96111
### Linting your code

0 commit comments

Comments
 (0)