mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2026-03-23 06:01:43 -05:00
referencing issue in footer #95
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: github-starred/conventionalcommits.org#95
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @cgatian on GitHub (Apr 3, 2020).
The spec doesnt call out where a referencing issue should be noted. By convention this is typically added to the footer.
Am I missing something? The beta contains an example, but the spec doesn't call it out.
@SuperOleg39 commented on GitHub (Jul 17, 2020):
Same question, i write some code for build link to issue from commit, and find to many variants to parsing:
Closes #ISSUE / closes #ISSUE / Closes ISSUE / closes ISSUE / Refs #ISSUE / refs #ISSUE / Refs ISSUE / refs ISSUE / Fix #ISSUE / fix #ISSUE / Fix ISSUE / fix ISSUE / Fixes #ISSUE / fixes #ISSUE / Fixes ISSUE / fixes ISSUE
@mainrs commented on GitHub (Jul 27, 2020):
As you said, by convention. Nothing holds me back from adding it to the body. It makes sense to include metadata about commits inside of footers. It's a separation of concerns.
The spec just defines how the parts are delimited and what type of content is allowed (e.g. body is everything, terminated with a footer token word plus a separator). What you make out of it is up to you.