Skip to content
Prev Previous commit
Next Next commit
mention coding style
  • Loading branch information
Dominik Neise committed Jun 27, 2019
commit 63846f3ec4d486151f5ba7337f07c329b923c13c
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,18 @@ Please submit patches by pull request where possible. Patches should add a test

If you are having trouble running/add/fixing tests for your patch let me know and I'll see if I can help.


Coding Style
==============

We'd like our code to follow PEP8 coding style in this project.
We use [python/black](https://github.com/python/black) in order to make our lives easier.
We propose you do the same within this project, otherwise you might be asked to
reformat your pull requests.

It's really simple just:

pip install black
black .

And there are plug ins for many editors.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also "plugins" is a single word (no space).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - done