Skip to content

Commit 61cd98d

Browse files
Add pre-commit to CONTRIBUTING.md
1 parent b9accef commit 61cd98d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,16 @@ Recommended steps for first time contributors:
2020
git pull
2121
pip install -e .
2222
```
23-
4. After adding and committing your fix or feature, ensure that code coverage is at least 90% (otherwise the PR will be rejected) and that linting is successfully executed using the following command:
23+
4. (Optional but recommended) Install pre-commit hooks:
24+
```bash
25+
pip install pre-commit
26+
pre-commit install
27+
```
28+
5. After adding and committing your fix or feature, ensure that code coverage is at least 90% (otherwise the PR will be rejected) and that linting is successfully executed using the following command:
2429
```bash
2530
tox
2631
```
27-
5. Create pull request to the original repository.
32+
6. Create a pull request to the original repository.
2833

2934
## Reporting a bug
3035

0 commit comments

Comments
 (0)