Skip to content

Documentation: incorrect rules examples #254

@cengels

Description

@cengels

Describe the bug

In the docs, some rules seem to have incorrect examples:

  • Scope empty shows an empty type in the "bad" example instead of an empty scope.
  • Scope format shows an incorrectly formatted description in the "bad" example instead of an incorrectly formatted scope.
  • Scope max length reads "Description length should be less than or equal to 72" under the example heading.
  • Type shows the example from scope.
  • Type empty shows an empty scope, not an empty type.
  • Type format has the same problem as scope format.

The defaults may also not be up-to-date anymore – for instance, when I ran commitlint without any configuration file and only a single-line commit, it printed description is empty or missing space in the beginning even though the default for the body empty rule is documented to be ignore.

Config

N/A

Error message

N/A

Expected behavior

N/A

Version

0.1.6

Additional context

N/A

Metadata

Metadata

Labels

bugSomething isn't working

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions