Skip to content

[TASK] Clarify Resolves requirement in commit message guide #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
linawolf merged 2 commits into from
Dec 11, 2025
Merged

[TASK] Clarify Resolves requirement in commit message guide #404

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fc71cd
[TASK] Clarify Resolves requirement in commit message guide
CybotTM Oct 28, 2025
5bf8cf4
[DOCS] Language checks
sarahmccarthy123 Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions Documentation/Appendix/CommitMessage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://tbaggery.com/2008/04/19/a-note-about-git-commit-
messages.html>`_ 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 <http://tbaggery.com/2008/04/19/a-note-about-git-commit-
messages.html>`_ 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!
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down