Skip to content

Commit 8fc71cd

Browse files
committed
[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.
1 parent 3172cca commit 8fc71cd

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

Documentation/Appendix/CommitMessage.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -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_ here by
245+
adding #[ISSUE_NUMBER]. The commit-msg hook will reject commits that
246+
do not have at least one `Resolves:` line. For **features** and **tasks**,
247+
it closes the issue on merge:
247248

248249
.. code-block:: text
249250
:caption: commit message
@@ -260,10 +261,12 @@ 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**, it simply adds a relation, no closing). This is optional and
267+
**cannot be used alone** - you must have at least one `Resolves:` line
268+
in addition to any `Related:` lines. You need to reference an issue on
269+
Forge_ by just adding the issue number like in:
267270

268271
.. code-block:: text
269272
:caption: commit message

0 commit comments

Comments
 (0)