diff --git a/Documentation/Appendix/CommitMessage.rst b/Documentation/Appendix/CommitMessage.rst index df310de..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! @@ -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_ 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 @@ -260,10 +261,11 @@ 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** 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 + as well. You reference the related issue on Forge_ by adding the issue number: .. code-block:: text :caption: commit message