Skip to content

Commit

Permalink
Add contribution guide to README
Browse files Browse the repository at this point in the history
Start a little contribution guide in the README. Mention that this
project uses pre-commit hooks and describe how to install them.
  • Loading branch information
Glutexo authored and dehort committed Jul 24, 2019
1 parent be04a40 commit 009dbbb
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,18 @@ This is the Base64 encoding of the following JSON document:
```json
{"identity": {"account_number": "0000001", "internal": {"org_id": "000001"}}}
```

## Contributing

This repository uses [pre-commit](https://pre-commit.com) to check and enforce code style. It uses
[Black](https://github.com/psf/black) to reformat the Python code and [Flake8](http://flake8.pycqa.org) to check it
afterwards. Other formats and text files are linted as well.

Install pre-commit hooks to your local repository by running:

```bash
$ pre-commit install
```

After that, all your commited files will be linted. If the checks don’t succeed, the commit will be rejected. Please
make sure all checks pass before submitting a pull request. Thanks!

0 comments on commit 009dbbb

Please sign in to comment.