Skip to content

Commit

Permalink
docs(readme): update example regexes
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Sep 8, 2021
1 parent 8a18e4d commit f420a5a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,13 +293,13 @@ This section contains the parsing and git related configuration options.
[git]
conventional_commits = true
commit_parsers = [
{ message = "^feat*", group = "Features"},
{ message = "^fix*", group = "Bug Fixes"},
{ message = "^doc*", group = "Documentation"},
{ message = "^perf*", group = "Performance"},
{ message = "^refactor*", group = "Refactor"},
{ message = "^style*", group = "Styling"},
{ message = "^test*", group = "Testing"},
{ message = "^feat", group = "Features"},
{ message = "^fix", group = "Bug Fixes"},
{ message = "^doc", group = "Documentation"},
{ message = "^perf", group = "Performance"},
{ message = "^refactor", group = "Refactor"},
{ message = "^style", group = "Styling"},
{ message = "^test", group = "Testing"},
]
filter_commits = false
tag_pattern = "v[0-9]*"
Expand Down Expand Up @@ -338,7 +338,7 @@ Examples:
- Group the commit as "Deprecation" if the commit body and message contains "deprecated".
- `{ message = "^revert", skip = true}`
- Skip processing the commit if the commit message (description) starts with "revert".
- `{ message = "^doc*", group = "Documentation", default_scope = "other"},`
- `{ message = "^doc", group = "Documentation", default_scope = "other"},`
- If the commit starts with "doc", group the commit as "Documentation" and set the default scope to "other". (e.g. `docs: xyz` will be processed as `docs(other): xyz`)
#### filter_commits
Expand Down

0 comments on commit f420a5a

Please sign in to comment.