Skip to content

Commit 3ea402b

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

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ 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+
#### Pre-commit plugin
52+
To forget about coding style, let [pre-commit](https://pre-commit.com/#installation) fix your `flake8`/`black`/`isort` issue.
53+
54+
```bash
55+
pip3 install pre-commit # required only once
56+
pre-commit install
57+
pre-commit run -a # this might show you that it failed but actually it didn't
58+
```
5159

5260
#### Coding Style
5361

@@ -74,13 +82,6 @@ We want your work to be readable by others; therefore, we encourage you to note
7482
pip3 install flake8 # only required the first time
7583
flake8 . --ignore=E203,W503 --max-line-length=88 --show-source
7684
```
77-
- All submissions will also have to pass **pre-commit**, this ensures that your code is perfectly formatted and does not have any trailing whitespaces, has empty line at the file ending. You can try this anytime between the pull request or before the pull request locally (This fixes most of the automated tests).
78-
79-
```bash
80-
pip3 install pre-commit # only required the first time
81-
pre-commit install
82-
pre-commit run -a # This might show you that it failed but actually it didn't
83-
```
8485

8586
- Original code submission require docstrings or comments to describe your work.
8687

0 commit comments

Comments
 (0)