Skip to content

Update CONTRIBUTING.md with pre-commit plugin instructions #3979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 28, 2020
Merged

Update CONTRIBUTING.md with pre-commit plugin instructions #3979

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dec2735
Update CONTRIBUTING.md
amaank404 Nov 28, 2020
3ea402b
Update CONTRIBUTING.md
amaank404 Nov 28, 2020
b28c53c
Update CONTRIBUTING.md
dhruvmanila Nov 28, 2020
87c8351
Update CONTRIBUTING.md
amaank404 Nov 28, 2020
ad7e310
Update CONTRIBUTING.md
amaank404 Nov 28, 2020
b947e1e
Update CONTRIBUTING.md
dhruvmanila Nov 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ Algorithms should:

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.

#### Pre-commit plugin
Use [pre-commit](https://pre-commit.com/#installation) to automatically format you code to match our coding style,

```bash
python3 -m pip install pre-commit # required only once
pre-commit install
```
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:

```bash
pre-commit run --all-files --show-diff-on-failure
```

#### Coding Style

We want your work to be readable by others; therefore, we encourage you to note the following:
Expand Down