Skip to content

Commit

Permalink
docs: mention Black and flake8 in the Contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
pbodnar committed Dec 21, 2023
1 parent fab40a4 commit b911e5b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ things to be aware of:
that way. That said, it's okay to go over the character limit occasionally.
* mistletoe uses four spaces instead of a tab to indent. For vim users,
include `set ts=4 sw=4 ai et` in your `.vimrc`.
* recommended Python tooling:
* [Black][black-formatter] as the code formatter
* [flake8][flake8] as the linter (style checker)

Apart from that, stay consistent with the coding style around you. But don't
get boggled down by this: if you have a genius idea, I'd love to clean up
Expand All @@ -108,3 +111,5 @@ I tweet [@mi_before_yu][twitter]. Also yell at me over [email][email].
[twitter]: https://twitter.com/mi_before_yu
[email]: mailto:[email protected]
[conv-commits]: https://www.conventionalcommits.org/
[black-formatter]: https://black.readthedocs.io/
[flake8]: https://flake8.pycqa.org/

0 comments on commit b911e5b

Please sign in to comment.