Pre-commit is an easy and straightforward way to run our checks before letting the commit go through. It's really useful to catch simple mistakes and then having to make another commit to fix those mistakes.
This pre-commit config creates hooks for flake8 and doc8. We could possibly create hooks for creating docs or even running the unit tests, but since those tests take some time, it's better to leave them out.
After #199 is merged, we should update the contributing guidelines in this PR to mention the config and then merge it.
Pre-commit is an easy and straightforward way to run our checks before letting the commit go through. It's really useful to catch simple mistakes and then having to make another commit to fix those mistakes. This pre-commit config creates hooks for
flake8anddoc8. We could possibly create hooks for creating docs or even running the unit tests, but since those tests take some time, it's better to leave them out.After #199 is merged, we should update the contributing guidelines in this PR to mention the config and then merge it.