Skip to content

Ambiguity over footer issue references #586

Open
@tomhampshire

Description

@tomhampshire

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions