AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-24 12:41:16 +00:00
Code Issues Projects Releases Wiki Activity

docs: Clarify autoclosing issues syntax

Browse Source 
Link to the GitLab documentation, and clarify that if no single commit
in a merge requests closes an issue, you should add a reference to the
issue in the commit message anyway.
This commit is contained in:
Emmanuele Bassi 2018-10-15 10:46:35 +01:00
parent 3939824d11
commit 0397c8b628
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -194,25 +194,22 @@ Closes #1234
- When committing code on behalf of others use the `--author` option, e.g. - When committing code on behalf of others use the `--author` option, e.g.
`git commit -a --author "Joe Coder <joe@coder.org>"` and `--signoff`. `git commit -a --author "Joe Coder <joe@coder.org>"` and `--signoff`.
- If your commit is addressing an issue, use the GitLab syntax to - If your commit is addressing an issue, use the
automatically close the issue on push: [GitLab syntax](https://docs.gitlab.com/ce/user/project/issues/automatic_issue_closing.html)
to automatically close the issue when merging the commit with the upstream
repository:
```plain ```plain
Closes #1234 Closes #1234
```
or:
```plain
Fixes #1234 Fixes #1234
```
or:
```plain
Closes: https://gitlab.gnome.org/GNOME/gtk/issues/1234 Closes: https://gitlab.gnome.org/GNOME/gtk/issues/1234
``` ```
- If you have a merge request with multiple commits and none of them
completely fixes an issue, you should add a reference to the issue in
the commit message, e.g. `Bug: #1234`, and use the automatic issue
closing syntax in the description of the merge request.
### Access to the GTK repository ### Access to the GTK repository
GTK is part of the GNOME infrastructure. At the current time, any GTK is part of the GNOME infrastructure. At the current time, any