Skip to content

Commit b28c53c

Browse files
authored
Update CONTRIBUTING.md
1 parent 3ea402b commit b28c53c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,18 @@ Algorithms should:
4848
* return all calculation results instead of printing or plotting them
4949

5050
Algorithms in this repo should not be how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values. Those calculations or manipulations can use data types, classes, or functions of existing Python packages but each algorithm in this repo should add unique value.
51+
5152
#### Pre-commit plugin
52-
To forget about coding style, let [pre-commit](https://pre-commit.com/#installation) fix your `flake8`/`black`/`isort` issue.
53+
To forget about coding style, let [pre-commit](https://pre-commit.com/#installation) fix your formatting issues.
5354

5455
```bash
55-
pip3 install pre-commit # required only once
56+
pip3 install pre-commit # required only once
5657
pre-commit install
57-
pre-commit run -a # this might show you that it failed but actually it didn't
58+
```
59+
That's it! The plugin will run every time you commit any changes. If there are any errors found during the run, fix them and commit those changes. You can even run the plugin manually on all files:
60+
61+
```bash
62+
pre-commit run --all-files --show-diff-on-failure
5863
```
5964

6065
#### Coding Style

0 commit comments

Comments
 (0)