Skip to content

Commit 9e7c9c4

Browse files
committed
Document how to use custom line limits
1 parent e99468c commit 9e7c9c4

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,10 @@ You need to have Python3 installed and follow the steps bellow:
6060
* Install NLTK corpora
6161
* `python3 -m textblob.download_corpora`
6262
* Run the script to verify a commit message
63-
* `python3 bad_commit_message_blocker.py --message "Add a really cool feature"`
63+
* `python3 bad_commit_message_blocker.py --message "Add a really cool feature"`
64+
* To define your own maximum character limits, call the script with the
65+
appropriate arguments:
66+
* `--subject-limit` (defaults to `50`) to set the subject line limit. E.g.:
67+
* `python3 bad_commit_message_blocker.py --subject-limit 80 --message "Add a really cool feature"`
68+
* `--body-limit` (defaults to `72`) to set the body line limit. E.g.:
69+
* `python3 bad_commit_message_blocker.py --body-limit 120 --message "Add a really cool feature"`

0 commit comments

Comments
 (0)