Skip to content

docs: Add default-stages to configuration #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
LordFckHelmchen wants to merge 1 commit into from
Closed

docs: Add default-stages to configuration #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<type>(<optional-scope>): <summary>
< ... empty line ... >
<optional body lines>
Expand Down Expand Up @@ -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.

-
Expand Down Expand Up @@ -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: <https://github.com/compilerla/conventional-pre-commit>
Loading