Configure pre-commit and pre-commit CI

[VeckoTheGecko]

Pre-commit and pre-commit CI allow for the quick and seamless detection (and in some cases auto-fixing) of various code quality issues (aka. pre-commit hooks, full list here).

If precommit is to be used locally:

• install pre-commit from PYPI/Conda-forge (pip install pre-commit, or conda install -c conda-forge pre-commit)
• run pre-commit install to set up the hooks listed in .pre-commit-config.yaml

Now when you commit, the hooks will be run before the commit is executed (aborting the commit if the hooks pick up errors they can't autofix).

For pre-commit CI, once configured it works automatically on PRs using the same .pre-commit-config.yaml. It commits to the branch for automatic fixes, and gives informative logs for changes it can't autofix.

This pre-commit workflow would replace GitHub actions for linting workflows.

Current hooks:

• trailing-whitespace
• end-of-file-fixer
• check-yaml
• check-ast (checks files parse as valid Python)
• flake8

Potential additional hooks:

• tabs to spaces
• docstring linting (future)
• code formatting (Code formatter #1284)

Configuration of pre-commit CI:

• Go to pre-commit.ci, sign in with GitHub, and authorize on this repo

Fixes #1285

[VeckoTheGecko]

Converted to draft (waiting on outcome of #1283)

[VeckoTheGecko]

Is this something that would be welcome in Parcels? If so, should we add pre_commit as a dev dependency so people can set up the hooks locally?

[erikvansebille]

Is this something that would be welcome in Parcels? If so, should we add pre_commit as a dev dependency so people can set up the hooks locally?

I think the option of using the pre-commit workflow is nice! I just tried it and it works smoothly. So yes, let's add pre-commit to the environment files. Do you want to do that, @VeckoTheGecko?

[VeckoTheGecko]

Do you want to do that, @VeckoTheGecko?

Happy to do so. Will do it within the hour

[VeckoTheGecko]

Should I also remove the flake8 workflow @erikvansebille ? If we're using pre-commit CI, then we'd have doubleup with the flake8 linting (GitHub actions + precommit CI)