node-semantic-git-commit-cli icon indicating copy to clipboard operation
node-semantic-git-commit-cli copied to clipboard

Enable option to add footer at the end of the commit message

Open ssuperczynski opened this issue 6 years ago • 3 comments

CI tools like Gitlab, Github, Bitbucket or Jira reads footer of the commit. It is helpful to link, or to trigger an action if footer of the commit is applied.

It is described in the https://www.conventionalcommits.org/en/v1.0.0/#summary

I'd like to add this feature. Let me know if this sounds good to you to be added.

<type>(<scope>)<delimiter> <message>

<body>

<footer>

ssuperczynski avatar Nov 19 '19 10:11 ssuperczynski

Sounds great. But what if there is no <body> applied? Are there 2 or 3 breaks?

(\n's are just for clarification)

<type>(<scope>)<delimiter> <message>
\n
\n
<footer>

or

<type>(<scope>)<delimiter> <message>
\n
\n
\n
<footer>

Or is a body mandatory for a footer?

JPeer264 avatar Nov 19 '19 10:11 JPeer264

ping @ssuperczynski

JPeer264 avatar Jun 12 '20 07:06 JPeer264

@JPeer264 I would like to upvote this issue (I came here to open a similar request and found it already exists).

I would suggest that it's either that the body is mandatory for the footer, or that it's 2 blank lines as in your first example.

AngularJS has some additional information from this Google Doc.

aaron-junot avatar May 11 '22 22:05 aaron-junot