conventional-commits / conventionalcommits.org

The conventional commits specification
https://conventionalcommits.org
MIT License
6.73k stars 520 forks source link

Refine commit message format grammar #473

Open 1e9y opened 1 year ago

1e9y commented 1 year ago

Current suggested format doesn't clearly state correct usage of optional scope. Commit header defined as following:

<type>[optional scope]: <description>

While later in text scope is defined as "contextual information and is contained within parenthesis". That means commit header should have following form:

<type>[(<scope>)]: <description>

Square brackets here means optional block. Parenthesis are literal symbols. <scope> is an arbitrary string.