aspect docs example

FirstCharacter

Metadata.CommitMessage.Shortlog.FirstCharacter

Parent

Index

Top

FirstCharacter

The first character of your commit message shortlog (first line) usually should be upper or lower case consistently.

If the commit message contains a colon, only the first character after the colon will be checked.

Settings

Settings

Setting	Meaning	Suggested Values
shortlog_starts_upper_case	Whether or not the shortlog (first line) of a commit message should start with an upper case letter consistently.	True, False

Example

Add coverage pragma
Compatability: Add coverage pragma
add coverage pragma
Compatability: add coverage pragma

Importance

Consistent commit messages are easier to read through.

How to fix

Convert your first character to upper/lower case. If your message starts with an identifier, consider rephrasing. Usually starting with a verb is a good idea.