Skip to content

Commit 4540b46

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 178a765 commit 4540b46

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
@@ -57,6 +57,21 @@ Changes should always include tests. If this is a bug fix it is a good idea to a
5757
first commit of the pull request and the changes to fix the issue in subsequent commits to make it
5858
easier to validate it.
5959

60+
### Running tests before submitting pull request
61+
62+
To run local tests, first install the test requirements:
63+
64+
```shell
65+
python3 -m pip install --upgrade pip
66+
python3 -m pip install -e . --group test
67+
```
68+
69+
Then, run the check:
70+
71+
```shell
72+
make check
73+
```
74+
6075
## Pull requests
6176

6277
### Linting your code

0 commit comments

Comments
 (0)