From c79b975a1fa604ed0b2d73c4e28385bb3db20a62 Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Tue, 30 Jan 2024 18:26:18 +0100 Subject: [PATCH] [TASK] Remove Commit Messages conventions We do not have strict rules for commit messages. Where necessary we can refer to core rules, but we do not need to repeat them here. --- .../GeneralConventions/CommitMessages.rst | 128 ------------------ Documentation/GeneralConventions/Index.rst | 1 - Documentation/Maintainers/BackportChanges.rst | 3 +- Documentation/Maintainers/Changelog.rst | 2 - .../WritingDocsOfficial/LocalEditing.rst | 2 - 5 files changed, 1 insertion(+), 135 deletions(-) delete mode 100644 Documentation/GeneralConventions/CommitMessages.rst diff --git a/Documentation/GeneralConventions/CommitMessages.rst b/Documentation/GeneralConventions/CommitMessages.rst deleted file mode 100644 index de68313a..00000000 --- a/Documentation/GeneralConventions/CommitMessages.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. include:: /Includes.rst.txt -.. index:: Git; Commit messages -.. _general-conventions-commit-messages: - -=============== -Commit messages -=============== - -The Documentation Team currently does not have strict "rules" for commit messages. These -are recommendations. - -Commit message recommendations -============================== - -* Write commit messages that are **clear**, **concise** and **meaningful** -* Use imperative form: "Fix typo" (instead of "Fixed typo"). This is - seen from the person, that is going to apply your patch: What will the patch do? - Fix typo! -* As in the TYPO3 core commit message rules, try to keep first line below 52 characters - if possible, but below 80 in any case. -* A commit message for the docs should consists of a subject line (first line). - More lines (separated by first line with an empty new line) are optional. - - -.. index:: Git; Resolves - -Issues ------- - -If an issue exists, link to it, by using for example "Resolves: #issue number", for example:: - - Resolves: #4 - -"Resolves" will automatically close the issue, using "Related" will not. - -You can also cross link to issues in other repositories in TYPO3-Documentation:: - - Related: TYPO3-Documentation/T3DocTeam#121 - -.. seealso:: - - * Stack Overflow: `Link to the issue number on GitHub within a commit message `__ - - -.. index:: Git; Releases - -Releases --------- - -If it should be backported to an older branch, use `Releases:` (as in :ref:`t3contribute:commitmessage`):: - - Releases: main, 11.5 - - -Examples -======== - -Example commit message with issue ---------------------------------- - -.. code-block:: none - - Add chapter for commit message rules - - Resolves: #4 - -This consists of the following parts: - -.. code-block:: none - - - - Resolves: # - -The issue number is optional. GitHub will automatically create a link to -the issue. - - -If you are editing online with GitHub, this may look like this: - -.. image:: /Images/commit-msg.png - :class: with-shadow - - - -Using "Resolves", will automatically close the issue. You can use "Related" instead of -"Resolves" if you do not want the issue to be closed. - -You can refer to more than one issue: - -.. code-block:: none - - - - Resolves: # - Resolves: # - -Add the branches to which the change should be added: - -.. code-block:: none - - - - Resolves: # - Releases: main, 11.5 - - -Using TYPO3 Core commit message rules -===================================== - -If you wish, you can use the prefixes [BUGFIX],[FEATURE],[TASK] etc. -as is customary in core development -(see :ref:`t3contribute:commitmessage`). - -However, this is not mandatory throughout the docs at the moment. If -possible, use the conventions, that are being used in -the manual in which you are working, for example `TYPO3 Explained commits -`__ -typically use these conventions. - - -Additional Information -====================== - -* `How to write a git commit message `__ -* :ref:`t3contribute:commitmessage` in TYPO3 Contribution Guide - Core Development - - diff --git a/Documentation/GeneralConventions/Index.rst b/Documentation/GeneralConventions/Index.rst index 2afa3879..05caa765 100644 --- a/Documentation/GeneralConventions/Index.rst +++ b/Documentation/GeneralConventions/Index.rst @@ -103,5 +103,4 @@ be found in the subchapters. Format CodingGuidelines GuidelinesForImages - CommitMessages Licenses diff --git a/Documentation/Maintainers/BackportChanges.rst b/Documentation/Maintainers/BackportChanges.rst index 4be3ccf5..6c4c2049 100644 --- a/Documentation/Maintainers/BackportChanges.rst +++ b/Documentation/Maintainers/BackportChanges.rst @@ -10,8 +10,7 @@ Backport changes Most of the time changes will be made to branch `main` and backported. When creating a pull request, it is possible to add a `Releases` line in the -:ref:`commit message ` -(as done in the Core): +commit message (as done in the Core): .. code-block:: text diff --git a/Documentation/Maintainers/Changelog.rst b/Documentation/Maintainers/Changelog.rst index 23ca82fd..7acbfd69 100644 --- a/Documentation/Maintainers/Changelog.rst +++ b/Documentation/Maintainers/Changelog.rst @@ -37,8 +37,6 @@ their commit message to the issue, for example Resolves: https://github.com/TYPO3-Documentation/Changelog-To-Doc/issues/790 Releases: main -See also: :ref:`general-conventions-commit-messages`. - .. index:: Documentation; Deprecations reST directives; deprecated diff --git a/Documentation/WritingDocsOfficial/LocalEditing.rst b/Documentation/WritingDocsOfficial/LocalEditing.rst index 314b1f9d..044ba109 100644 --- a/Documentation/WritingDocsOfficial/LocalEditing.rst +++ b/Documentation/WritingDocsOfficial/LocalEditing.rst @@ -98,8 +98,6 @@ the ability to experiment and preview your changes locally before submitting the git commit -a Write a short, meaningful commit message describing what changes you have made. - See :ref:`general-conventions-commit-messages` for more information on how to - word your commit messages. 9. Push changes