[gtk/commit-docs] docs: Clarify autoclosing issues syntax
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/commit-docs] docs: Clarify autoclosing issues syntax
- Date: Mon, 15 Oct 2018 09:49:27 +0000 (UTC)
commit 56f19e06c6f5d8f2d6c65b4746cf25e7e4121f87
Author: Emmanuele Bassi <ebassi gnome org>
Date: Mon Oct 15 10:46:35 2018 +0100
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.
CONTRIBUTING.md | 21 +++++++++------------
1 file changed, 9 insertions(+), 12 deletions(-)
---
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index deacf58424..301782e39f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -191,25 +191,22 @@ brief.
- 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]