Contributing pre-commit hooks about documentation HOT 5 CLOSED

So it's about documenting how users could set those .pre-commit hooks into their local repo fork+clone?
How does it work with PR that are made by creating a branch in this upstream repo?
We also don't want to just reject any submission (like from less technical people using only the basic github web UI to make some small change), at least once we have a PR we can help getting things cleaned.

from documentation.

Yes, the .pre-commit-config.yml file declares which hooks are active.

We can reasonably expect a contributor to install them in their development environment:

$ pip install pre-commit
$ pre-commit install

It is not required to install them, but since they declare the baseline hygiene of the codebase, it makes it much easier to converge on. Contributors can look at them and have an idea of the conventions adopted in the codebase.

They can be included in all PR CI runs either breaking the build, or emitting a warning.

As I mentioned, running pre commit hooks after the actual commit has happened is a bit ... "wrong", so the best case scenario is that they are installed and used by the main contributors. If not, you run the risk of having to manually clean the commit history if something bad (like a secret, a huge file, or something that breaks prod) gets into the codebase by accident.

Shall I send a PR and we can have a look?

from documentation.

WIP #636

from documentation.

This can be closed -- sorry forgot to mention it in #636

from documentation.

Closed by #636

from documentation.