ENH: Require space and capital letter after colon in commit message first line

[Leengit]

Enforce that there be (at least) one space after BUG:, COMP:, DOC:, ENH:, PERF:, or STYLE: at the start of the first line of a commit message.

Current usage shows me the following counts in the git log for trailing spaces. In no cases were there 3 or more spaces.

     39 'BUG:  '
  11109 'BUG: '
     39 'BUG:'
     55 'COMP:  '
   6642 'COMP: '
      6 'COMP:'
      6 'DOC:  '
   1110 'DOC: '
      0 'DOC:'
     86 'ENH:  '
  16342 'ENH: '
     73 'ENH:'
      4 'PERF:  '
    225 'PERF: '
      0 'PERF:'
     14 'STYLE:  '
   3610 'STYLE: '
     11 'STYLE:'

[jamesobutler]

It appears that some of these enforcements are slightly different than what is actually being enforced as a GitHub status check prior to integration.

Slicer/.github/workflows/commit-message.yml

Line 24 in ef38f69

pattern: '^(ENH|PERF|BUG|STYLE|DOC|COMP): ([A-Z])+'

Slicer/.github/workflows/commit-message.yml

Line 34 in ef38f69

pattern: '^[^#].{1,78}$'

For example this file also states printErrorAndExit 'The first line must be at least 8 characters:, but that is not included in the commit-message.yml.

I wonder if there is a better to way to keep the two areas in sync.

[jcfr]

The pull-request has been rebased to include change recently integrated through:

• COMP: Skip ReadTheDocs build for "hooks" branch #7369

[Leengit]

I agree with @jamesobutler that we would benefit from tighter integration between the sets of checks. If it isn't already, perhaps you could add that as an issue. Should we go ahead with this pull request?

[Leengit]

This latest push adds a check that both a space and a capital letter follow the colon. It also simplifies the if statement to use egrep.

[Leengit]

Note that the checks that the line length is at least 8 and at most 78 occur earlier in the code, but could be added here with

if echo "$line" | egrep -qx '(BUG|COMP|DOC|ENH|PERF|STYLE): [A-Z].*' &&
        echo "$line" | egrep -qx '.{8,78}'; then
  # first line okay
  ...