gradslam/gradslam

Contributing guidelines on linting

Closed this issue ยท 2 comments

๐Ÿ“š Documentation

The current CONTRIBUTING guide suggests contributors to first run black gradslam and then check for flake8 gradslam errors.

A better way would be to reverse the two steps (i.e., first run flake8 to enlist files with errors, and then run black ONLY on these files).

Everything in gradslam is currently linted with black. So running black gradslam will only change the files modified in the PR. Running flake8 afterwards will show any extra imports which won't be fixed by black, and have to be checked manually.

Closing due to inactivity