diff options
| author | Emmanuele Bassi <ebassi@gnome.org> | 2018-10-15 10:46:35 +0100 |
|---|---|---|
| committer | Emmanuele Bassi <ebassi@gnome.org> | 2018-12-28 18:44:36 +0000 |
| commit | 0397c8b6287e0fc2614a84e9350bd33316c3dbf2 (patch) | |
| tree | 6efce8de5d1ab15480ca6ef3ee11a8acee314dca /CONTRIBUTING.md | |
| parent | 3939824d11e917659b3159a78cf5852902986ae4 (diff) | |
| download | gtk+-0397c8b6287e0fc2614a84e9350bd33316c3dbf2.tar.gz | |
docs: Clarify autoclosing issues syntax
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.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1aef7a3dc..8fffe4d678 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -194,25 +194,22 @@ Closes #1234 - When committing code on behalf of others use the `--author` option, e.g. `git commit -a --author "Joe Coder <joe@coder.org>"` and `--signoff`. - - If your commit is addressing an issue, use the GitLab syntax to - automatically close the issue on push: + - If your commit is addressing an issue, use the + [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 Closes #1234 -``` - - or: - -```plain Fixes #1234 -``` - - or: - -```plain 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 GTK is part of the GNOME infrastructure. At the current time, any |