Skip to content

Commit 45c9307

Browse files
[TASK] Clarify Resolves requirement in commit message guide (#404)
* [TASK] Clarify Resolves requirement in commit message guide Make it explicit that 'Resolves:' is required and 'Related:' is optional. The commit-msg hook rejects commits without at least one 'Resolves:' line, but this was not clearly stated in the documentation. Changes: * Mark 'Resolves:' as (REQUIRED) and clarify it is mandatory * Add note that commit-msg hook rejects commits without Resolves * Mark 'Related:' as (OPTIONAL) and clarify it cannot be used alone * Emphasize that at least one 'Resolves:' line is needed This addresses confusion where contributors used only 'Related:' and had their commits rejected. * [DOCS] Language checks Releases: main --------- Co-authored-by: Sarah McCarthy <[email protected]>
1 parent ff4f018 commit 45c9307

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

Documentation/Appendix/CommitMessage.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
Commit Message rules for TYPO3 CMS
1111
===================================
1212

13-
Since we strive to automate a lot of things the commit message plays an
14-
important role in order to be able to automate.
13+
In TYPO3 we try to automate the contribution/coding process as much as possible
14+
and the commit message plays an important role in that.
1515

16-
Git and related tools work best when following a certain guideline for commit
17-
messages. A deeper `introduction on git revision log conventions <http://tbaggery.com/2008/04/19/a-note-about-git-commit-
18-
messages.html>`_ is helpful to understand the scope.
16+
Git and related tools work best when following strict guidelines for commit
17+
messages. The `introduction to git revision log conventions <http://tbaggery.com/2008/04/19/a-note-about-git-commit-
18+
messages.html>`_ explains the guidelines in more detail.
1919

2020
Here is an example of a final commit message. The `Change-Id` will be generated
2121
by the commit-hook. Do not set the `Change-Id` on your first commit!
@@ -240,10 +240,11 @@ Relationships
240240
Resolves: #67890
241241
242242
243-
#. `Resolves:`
244-
You need to reference an issue on Forge_ here simply by
245-
adding #[ISSUE_NUMBER]. For **features** and **tasks**, it closes the
246-
issue on merge.:
243+
#. `Resolves:` **(REQUIRED)**
244+
You **must** reference an issue on Forge_ by
245+
adding the #[ISSUE_NUMBER]. The commit-msg hook rejects commits that
246+
do not have at least one `Resolves:` line. For **feature** and **task** commits,
247+
the resolved issues are closed on merge:
247248

248249
.. code-block:: text
249250
:caption: commit message
@@ -260,10 +261,11 @@ Relationships
260261
261262
Resolves: #M12345
262263
263-
#. `Related:`
264+
#. `Related:` **(OPTIONAL)**
264265
Other issues related to this change which are not resolved (for **all
265-
types**, it simply adds a relation, no closing). You need to reference an
266-
issue on Forge_ by just adding the issue number like in:
266+
types** of commit, it only adds relations and the issues are not closed). This is optional and
267+
**cannot be used alone** - you must have at least one `Resolves:` line
268+
as well. You reference the related issue on Forge_ by adding the issue number:
267269

268270
.. code-block:: text
269271
:caption: commit message

0 commit comments

Comments
 (0)