Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ambiguity over footer issue references #586

Open
tomhampshire opened this issue May 22, 2024 · 0 comments
Open

Ambiguity over footer issue references #586

tomhampshire opened this issue May 22, 2024 · 0 comments

Comments

@tomhampshire
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant