Refine commit message format grammar #156

New Issue

GiteaMirror · 2026-02-17T11:50:21-06:00

GiteaMirror commented

2026-02-17 11:50:21 -06:00

Originally created by @1e9y on GitHub (Sep 29, 2022).

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.

Originally created by @1e9y on GitHub (Sep 29, 2022). 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.

GiteaMirror commented

2026-02-17 11:50:22 -06:00

@malware2101 commented on GitHub (Jan 10, 2025):

can you assign me this!!

@malware2101 commented on GitHub (Jan 10, 2025): can you assign me this!!

GiteaMirror commented

2026-02-17 11:50:23 -06:00

@bcoe commented on GitHub (Jan 15, 2025):

@malware2101 please go ahead and submit a PR 👍

@bcoe commented on GitHub (Jan 15, 2025): @malware2101 please go ahead and submit a PR 👍

GiteaMirror referenced this issue

2026-02-17 11:59:07 -06:00