search

adafruit / cookiecutter-adafruit-circuitpython

Cookiecutter template for Adafruit's CircuitPython libraries.
MIT License
22 stars 37 forks source link

Add another pre-commit hook to run Pylint on tests directories as with examples #113

Closed kattni closed 3 years ago

kattni commented 3 years ago

We need to add a third Pylint pre-commit hook to run on the tests directory, similar to the one for the examples directory, except only disable=missing-docstring (leave out invalid-name). As an example, see this commit.

There are very few libraries that have a tests directory, but in moving Pylint to Pre-Commit, we found it failing on the datetime library tests. After discussion, we came to a few of conclusions. One, datetime is special and will be handled on an individual basis. Two, we should not patch all the libraries to include this new pre-commit hook, we should only add it to the libraries that currently have tests directories. Three, we should add the new hook to cookiecutter so it's on any future libraries that may include tests directories.

kattni commented 3 years ago

@hugodahl agreed to pick this up. Thanks again!

kattni commented 3 years ago

Completed!