|author||Virgil Dupras <firstname.lastname@example.org>||2018-08-14 11:32:05 -0400|
|committer||Virgil Dupras <email@example.com>||2018-08-14 11:32:05 -0400|
|parent||Add (and fix) flake8 checks in tox (diff)|
As of now, pylint checks return a metric ton of warnings, which tells us that it hasn't been running lately. pylint is replaced by flake8 and its continuous run will enventually be ensured by a CI running tox on this project. The immediate goal, for now, is to have an easy command that checks as much as possible, but that *passes* so that we don't litter the project with more code that decrease quality.
Diffstat (limited to 'README.dev')
1 files changed, 5 insertions, 5 deletions
@@ -25,12 +25,12 @@ Adding or modifying code:
- If you add new code, best practice is to write a test for it.
- If you're modifying code that doesn't have a test and you can write a test
for it, please do.
-- Before committing your changes to a python file, please make sure it passes
- pylint with:
-pylint --rcfile=pylintrc yourfile.py
-- If pylint raises a warning or error that you don't agree with, it's probably
+- Before committing your changes, run "tox" to ensure that you didn't break
+ tests or introduced a flake8 error.
+- If flake8 raises a warning or error that you don't agree with, it's probably
better to just change your code. If you're sure you have a good reason for
- doing what you're doing, you can add an exception to our pylintrc.
+ doing what you're doing, you can add "# noqa" at the end of the line to
+ silence it.
Creating a release: