docs(readme): add warning about split_commits flag

orhun · Aug 12, 2022 · 71b581a · 71b581a
1 parent 704deb0
commit 71b581a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -505,6 +505,8 @@ filter_unconventional = false
 
 #### split_commits
 
+> This flag violates "conventional commits". It should remain off by default if conventional commits is to be respected.
+
 If set to `true`, each line of a commit is processed individually, as if it were its own commit message. This may cause
 a commit to appear multiple times in a changelog, once for each match.