user does not need to run format and test manually anymore

[12rambau]

Type

• [X] Content inaccurate

URL

https://commitizen-tools.github.io/commitizen/contributing/

Description

I just edited the pre-commit hook in a PR and I realized the test and format script are run internally. would it make sense to remove these steps from both the contributing documentation and the PR checklist ?

On the other hand I faced many dificulties running them as my nevironment was missing a lot of the test/formatting dependencies. wouldn't it be better if these tests were run using isolated environments using either nox or tox ?

happy to make a PR

[woile]

I personally prefer to use the scripts and let the CI handle different python versions. What kind of difficulties did you have with the test/formatting? If you do poetry install you should have all the deps, including the development deps. There's a chance the problem is actually poetry, which is deprecating the section tool.poetry.dev-dependencies and instead, we have to create a new group tool.poetry.groups.dev for example

[12rambau]

nox is not forcing you to test multiple version of python. If you don't sepcify anything in the session parameter, it will use the python installed on your computer (in my case 3.10).

Note that it is not recommended to run the tests in pre-commits (quoting the author of pre-commits):

• tests are often slow, committing should be fast
• It would have to be a system / script hook since you'd need repository specific dependencies installed (as you've noticed)

The format script could be drop all together by using richer pre-commit hooks (namely the holy trinity: ruff, black, prettier)