Skip to content

Commit

Permalink
docs(README) Update default max summary length
Browse files Browse the repository at this point in the history
  • Loading branch information
tomassebestik committed Jun 30, 2023
1 parent 0888574 commit 81324ad
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The script supports additional parameters to customize its behavior:

- `--subject-min-length`: Minimum length of the 'Summary' field in commit message. Defaults to `20`.

- `--subject-max-length`: Maximum length of the 'Summary' field in commit message. Defaults to `50`.
- `--subject-max-length`: Maximum length of the 'Summary' field in commit message. Defaults to `72`.

- `--body-max-line-length`: Maximum length of a line in the commit message body. Defaults to `100`.

Expand Down Expand Up @@ -108,7 +108,7 @@ pytest
```
... or create a content in file `test_message.txt` and run:
```sh
python -m conventional_precommit_linter.hook --subject-min-length 20 --subject-max-length 50 --body-max-line-length 100 test_message.txt
python -m conventional_precommit_linter.hook --subject-min-length 20 --subject-max-length 72 --body-max-line-length 100 test_message.txt
```

.... or (with default arguments):
Expand Down

0 comments on commit 81324ad

Please sign in to comment.