conventional-commits / conventionalcommits.org

The conventional commits specification

Home Page:https://conventionalcommits.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ambiguity over footer issue references

tomhampshire opened this issue · comments

Given we want to reference two issues using the "Closes" key. The issue references are XYZ-1 and XYZ-2.

Point 8 of the current (v1.0.0) spec states: "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 : or # separator, followed by a string value (this is inspired by the git trailer convention)."

The git trailed convention would state that the footer should be:

Fixes: XYZ-1
Fixes: XYZ-2

which indicates that a given word token should be repeated if used multiple times, each with a separate string value.

However, the example given at the bottom of the v1.0.0 spec is:

revert: let us never again speak of the noodle incident

Refs: 676104e, a215868

which would indicate that each word token should be used once, and separate string values associated with the given word token are provided in a comma-separated list.

Which of these is the correct way to proceed?