Skip to content

Discuss use of keywords for linking issues that are closed by commits #58

@javier-godoy

Description

@javier-godoy

We need to discuss the use of keywords for linking issues that are closed by commits, and confirm whether Flowing Code Commit Message Guidelines / 1.0.0-rc.8 aligns with our current practice.

  1. According to the Guidelines, the commit message footer to be used for linking the issue that is closed by the commit is Close #. GitHub supports other keywords (closes, closed, fix, fixes, fixed, resolve, resolves and resolved). In some cases other keywords have been used. It seems we don't have a strong feeling about this point (and requesting changes in a PR just because they used the "wrong" footer seems too pedantic)

  2. GitHub also allows the keyword to be followed by colons (e.g. Closes: #) while the Guidelines do not allow that syntax.

  3. Both GitHub and the Guidelines specify that the keywords are case-insensitive, while common practice seems to be capitalizing only the first letter.

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussThe issue is scheduled for internal discussion

    Type

    No type

    Projects

    Status

    Inbox (needs triage)

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions