From 8fc71cda44696cea90a6c022a2c42eb4b37b96e5 Mon Sep 17 00:00:00 2001 From: Sebastian Mendel Date: Tue, 28 Oct 2025 09:05:29 +0100 Subject: [PATCH 1/2] [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. --- Documentation/Appendix/CommitMessage.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/Documentation/Appendix/CommitMessage.rst b/Documentation/Appendix/CommitMessage.rst index df310de..ad358f3 100644 --- a/Documentation/Appendix/CommitMessage.rst +++ b/Documentation/Appendix/CommitMessage.rst @@ -240,10 +240,11 @@ Relationships Resolves: #67890 -#. `Resolves:` - You need to reference an issue on Forge_ here simply by - adding #[ISSUE_NUMBER]. For **features** and **tasks**, it closes the - issue on merge.: +#. `Resolves:` **(REQUIRED)** + You **must** reference an issue on Forge_ here by + adding #[ISSUE_NUMBER]. The commit-msg hook will reject commits that + do not have at least one `Resolves:` line. For **features** and **tasks**, + it closes the issue on merge: .. code-block:: text :caption: commit message @@ -260,10 +261,12 @@ Relationships Resolves: #M12345 -#. `Related:` +#. `Related:` **(OPTIONAL)** Other issues related to this change which are not resolved (for **all - types**, it simply adds a relation, no closing). You need to reference an - issue on Forge_ by just adding the issue number like in: + types**, it simply adds a relation, no closing). This is optional and + **cannot be used alone** - you must have at least one `Resolves:` line + in addition to any `Related:` lines. You need to reference an issue on + Forge_ by just adding the issue number like in: .. code-block:: text :caption: commit message From 5bf8cf47934550a2bd4ea8aac78d5183308914a5 Mon Sep 17 00:00:00 2001 From: Sarah McCarthy Date: Tue, 28 Oct 2025 18:12:18 +0100 Subject: [PATCH 2/2] [DOCS] Language checks Releases: main --- Documentation/Appendix/CommitMessage.rst | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/Documentation/Appendix/CommitMessage.rst b/Documentation/Appendix/CommitMessage.rst index ad358f3..1b4dc55 100644 --- a/Documentation/Appendix/CommitMessage.rst +++ b/Documentation/Appendix/CommitMessage.rst @@ -10,12 +10,12 @@ Commit Message rules for TYPO3 CMS =================================== -Since we strive to automate a lot of things the commit message plays an -important role in order to be able to automate. +In TYPO3 we try to automate the contribution/coding process as much as possible +and the commit message plays an important role in that. -Git and related tools work best when following a certain guideline for commit -messages. A deeper `introduction on git revision log conventions `_ is helpful to understand the scope. +Git and related tools work best when following strict guidelines for commit +messages. The `introduction to git revision log conventions `_ explains the guidelines in more detail. Here is an example of a final commit message. The `Change-Id` will be generated by the commit-hook. Do not set the `Change-Id` on your first commit! @@ -241,10 +241,10 @@ Relationships #. `Resolves:` **(REQUIRED)** - You **must** reference an issue on Forge_ here by - adding #[ISSUE_NUMBER]. The commit-msg hook will reject commits that - do not have at least one `Resolves:` line. For **features** and **tasks**, - it closes the issue on merge: + You **must** reference an issue on Forge_ by + adding the #[ISSUE_NUMBER]. The commit-msg hook rejects commits that + do not have at least one `Resolves:` line. For **feature** and **task** commits, + the resolved issues are closed on merge: .. code-block:: text :caption: commit message @@ -263,10 +263,9 @@ Relationships #. `Related:` **(OPTIONAL)** Other issues related to this change which are not resolved (for **all - types**, it simply adds a relation, no closing). This is optional and + types** of commit, it only adds relations and the issues are not closed). This is optional and **cannot be used alone** - you must have at least one `Resolves:` line - in addition to any `Related:` lines. You need to reference an issue on - Forge_ by just adding the issue number like in: + as well. You reference the related issue on Forge_ by adding the issue number: .. code-block:: text :caption: commit message