diff --git a/README.md b/README.md index afaeeca..f1634ba 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ The same applies to running pre-commit hooks in CI (Continuous Integration) job Commit messages are validated against the following format: -``` +```text (): < ... empty line ... > @@ -97,8 +97,11 @@ For a simplified setup (just with `pre-commit install` without flags), ensure yo --- minimum_pre_commit_version: 3.3.0 default_install_hook_types: [pre-commit, commit-msg] +default_stages: [pre-commit] ``` +**Notes**: Specifying `default_stages: [pre-commit]` avoids running all other hooks in the `commit-msg` stage (which produces a very verbose output). This requires that you specify `stages: [commit-msg]` for the **Conventional Precommit Linter** hook as above (otherwise it will be ignored). + After modifying `.pre-commit-config.yaml`, re-run the installation command (`pre-commit install`) for changes to take effect. - @@ -148,4 +151,4 @@ If you encounter any issues, feel free to report them in the [project's issues]( ## Credits -Inspired by project: https://github.com/compilerla/conventional-pre-commit +Inspired by project: