diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ac476bcce..9dca452bd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,3 +7,4 @@ Delete them if they are not appropriate for this pull request. - [ ] I have properly documented new or changed features in the documention or in the docstrings - [ ] I have properly documented unusual changes to the code in the comments around it - [ ] I have made note of any breaking/backwards incompatible changes +- [ ] I formatted my code using `black -t py36` \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 960ecc1c0..00621b7d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,13 @@ ## Keeping/Improving code quality -- Respect PEP8 standards! +- Respect PEP8 conventions! - Just the right amount of comments. Try to write auto-documented code (with very explicit variable names). - If you introduce a new functionality or fix a subtle bug, document it in the docstring/code. +- Moviepy's team adopted [black](https://github.com/psf/black) to autoformat the code. This is enforced for any pull request. + +> Tip: use `black -t py36 .` to autoformat your code, or set black as a plugin of your editor. + ## Using Github