-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: mention Black and flake8 in the Contribution guide
- Loading branch information
Showing
1 changed file
with
5 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
@@ -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/ |