question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support commit body and footer

See original GitHub issue

One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a :<space> or <space># separator, followed by a string value (this is inspired by the git trailer convention).

A footer’s token MUST use - in place of whitespace characters, e.g., Acked-by (this helps differentiate the footer section from a multi-paragraph body). An exception is made for BREAKING CHANGE, which MAY also be used as a token.

A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.

Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.

If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., BREAKING CHANGE: environment variables now take precedence over config files.


“Support” means completion for the BREAKING CHANGE token is available in the right contexts, as per specification.

The : (colon) character will be automatically inserted and the caret will be placed one space after it.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:9 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
notbearcommented, Mar 29, 2020

@lppedd Works as a charm. Well done, thanks!

0reactions
lppeddcommented, Mar 29, 2020

@notbear btw, now that I handle body, footer type and footer value differently I’m open to integrations such as with Github Issues

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to write a commit message that will make your mom proud
The footer text is found immediately below the body and is a place to reference issues related to the commit changes. The body...
Read more >
Conventional Commits
A commit body is free-form and MAY consist of any number of newline separated paragraphs. One or more footers MAY be provided one...
Read more >
How to add commit message in Git [Practical Examples]
You can just use git commit -m "MESSAGE" to add a commit message for any ... To write a commit body and footer...
Read more >
How to Write Better Git Commit Messages – A Step-By-Step ...
Now that we've covered basic commit structure of a good commit message, I'd like to introduce Conventional Commits to help provide some detail ......
Read more >
Commit Message Format - gists · GitHub
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found