[Feature Request] Add pre-commit integration

[alecgerona]

Description

Currently, the contributing guide states that we run the lints and tests manually before resolving a commit. Why not force this already by using pre-commit?

Possible Solution

Add pre-commit config file and dev dependency.

[Lee-W]

do you mean generate it when running cz init?

[alecgerona]

Nope. Basically adding pre-commit-config.yaml to the repository and having contributors run pre-commit install before running a commit to make sure that their staged changes and commit message are linted and follow convention.

[alecgerona]

We could also add pre-commit install to poetry scripts so it enforces the standard.

[Lee-W]

Nope. Basically adding pre-commit-config.yaml to the repository and having contributors run pre-commit install before running a commit to make sure that their staged changes and commit message are linted and follow convention.

Yep, it sounds good to me 🚀

We could also add pre-commit install to poetry scripts so it enforces the standard.

Do you mean to set it up for contributors when they run poetry install? How could we achieve it?

[alecgerona]

I was thinking maybe using poetry scripts but that looks like it doesn't behave the same way as package.json's postinstall. It's okay though. We should be enforcing the convention at CI level too. So before tests start, pre-commit run -a should not fail.

[Lee-W]

We already have those scripts under scripts. I think I'll have the time to set up the pre-commit config late today.

[alecgerona]

The scripts would be redundant with the pre-commit config. I can also submit a PR if you'd like.

[Lee-W]

#216 merged.