summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJoris Roovers <jroovers@cisco.com>2015-09-25 10:11:16 +0200
committerJoris Roovers <jroovers@cisco.com>2015-09-25 10:11:16 +0200
commit83db6248f0c2907a2adc7782060e98fb403f4ded (patch)
tree743fafbfa302c039186c0b27ef7f09a42f325180 /README.md
parentb6b32b9b93583fac00b433f8b3ea46244ef442e8 (diff)
ignore-merge-commit option for body-is-missing rule
This new option allows users to choose whether the body-is-missing rule should be ignored for merge commits. This commit also adds the BoolOption class which was required to add this new boolean option.
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1706a7a..eb76c9b 100644
--- a/README.md
+++ b/README.md
@@ -149,6 +149,11 @@ line-length=30
[body-min-length]
min-length=5
+[body-is-missing]
+# Whether to ignore this rule on merge commits (which typically only have a title)
+# default = True
+ignore-merge-commits=false
+
[body-changed-file-mention]
# List of files that need to be explicitly mentioned in the body when they are changed
# This is useful for when developers often erroneously edit certain files or git submodules.