README.adoc in git-lint-7.0.0 vs README.adoc in git-lint-7.1.0

- old
+ new

@@ -392,29 +392,36 @@ ==== Commit Body Bullet Capitalization [options="header"] |=== | Enabled | Severity | Defaults -| true | error | includes: `["\\-", "\\*"]` +| true | error | includes: `["\\*", "\\-"]` |=== Ensures commit body bullet lines are capitalized. Example: .... # Disallowed - an example bullet. # Allowed -- An example bullet. +* An ASCII Doc bullet. +* link:https://demo.com[Demo] +* link:https://demo.com[demo] +- A Markdown bullet. +- [Demo](https://demo.com) +- [demo](https://demo.com) .... +In general, using ASCII Doc or Markdown syntax directly after a bullet will cause capitalization checks to be ignored because there can be valid reasons for wanting to avoid capitalization in those situations. + ==== Commit Body Bullet Delimiter [options="header"] |=== | Enabled | Severity | Defaults -| true | error | includes: `["\\-", "\\*"]` +| true | error | includes: `["\\*", "\\-"]` |=== Ensures commit body bullets are delimited by a space. Example: .... @@ -428,11 +435,11 @@ ==== Commit Body Bullet Only [options="header"] |=== | Enabled | Severity | Defaults -| true | error | includes: `["\\-", "\\*"]` +| true | error | includes: `["\\*", "\\-"]` |=== Ensures a single bullet is never used when a paragraph could be used instead. Example: .... @@ -674,11 +681,11 @@ ==== Commit Subject Suffix [options="header"] |=== | Enabled | Severity | Defaults -| true | error | excludes: `["\\.", "\\?", "\\!"]` +| true | error | excludes: `["\\!", "\\.", "\\?"]` |=== Ensures commit subjects are suffixed consistently. The exclude list _is_ case sensitive and prevents the use of punctuation. This is handy when coupled with a tool, like link:https://alchemists.io/projects/milestoner[Milestoner], which automates project milestone @@ -1174,15 +1181,15 @@ You can add Rake support by adding the following to your `Rakefile`: [source,ruby] ---- begin - # require "git/lint/rake/register" + require "git/lint/rake/register" rescue LoadError => error puts error.message end -# Git::Lint::Rake::Register.call +Git::Lint::Rake::Register.call ---- Once required and registered, the following tasks will be available (i.e. `bundle exec rake -T`): ....