Skip to content

DevNotes_DevGuide_CommitMessage

Jump to bottom
Ricardo Ferraz Leal edited this page Apr 1, 2019 · 11 revisions

How to link commits and pull requests with GitHub issue actions

Issues being addressed by a commit or pull request should be referred to in that commit or pull request. Most often you will be closing the issue with the pull request. To do so use one of the magic words below in the commit message or the pull request.

To refer to issues in commit messages simply type the issue ref. In order to have the issue be closed whenever the change is merged into master, the syntax is of the form [command] [issueno]. A colon between the command and the issue reference is allowed as is capitalization of the command. The allowed commands are given below:

close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved

NOTE : unlike with track each issue to be closed must be individually prefaced by the command.for example:

closes #10 and will also Close #11

NOTE2 : to reference an issue within the current repository [issueno] is just #issueno. To reference an issue in another repository however [issueno] is username/repository#issueno. for example to reference a sasview issue from a sasview commit use #10 . To reference a sasmodels issue in a sasview commit use SasView/sasmodels#10

The full documentation is available on github: ​​ ​https://help.github.com/en/articles/closing-issues-using-keywords

Clone this wiki locally