Pre-commit

[vwxyzjn]

You can reproduce the existing pipeline with pre-commit run --all-files (note that pre-commit however only applies to git's staged and already committed files). I didn't fix the typo pointed out by codespell because it might create too many merge conflicts with existing PRs.

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[lvwerra]

Can you elaborate how to use it in a workflow? Can you register this as a git hook or would you run it manually?

[vwxyzjn]

There are two workflows to use it

1. A lot of people use pre-commit install to register it with git hooks so it runs automatically when you commit. Personally I don't like it because it doesn't let you confirm your changes
2. I like to use pre-commit run --all-files as a drop-in replacement for make format. The only difference is currently we manually specify check_dirs, whereas pre-commit's check_dirs will include all the committed and staged files (and don't include the untracked files).

[lvwerra]

Sounds good to me. What to you think about adding pre-commit run --all-files to the Makefile e.g. as make format. A few commands less to remember :)

What do you think @younesbelkada ?

[younesbelkada]

the changes sounds good, I also agree we should add something in the lines that @lvwerra mentioned on the Makefile

[vwxyzjn]

@lvwerra @younesbelkada good idea! Done with make commit

[younesbelkada]

Thank you @vwxyzjn !