1010Commit 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
2020Here is an example of a final commit message. The `Change-Id ` will be generated
2121by the commit-hook. Do not set the `Change-Id ` on your first commit!
@@ -241,10 +241,10 @@ Relationships
241241
242242
243243 #. `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:
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:
248248
249249 .. code-block :: text
250250 :caption: commit message
@@ -263,10 +263,9 @@ Relationships
263263
264264 #. `Related: ` **(OPTIONAL) **
265265 Other issues related to this change which are not resolved (for **all
266- types **, it simply adds a relation, no closing ). This is optional and
266+ types ** of commit , it only adds relations and the issues are not closed ). This is optional and
267267 **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:
268+ as well. You reference the related issue on Forge _ by adding the issue number:
270269
271270 .. code-block :: text
272271 :caption: commit message
0 commit comments