Skip to content

Commit

Permalink
[TASK] Remove Commit Messages conventions (#388)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
linawolf authored Jan 30, 2024
1 parent 41e6edc commit b29663d
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 152 deletions.
128 changes: 0 additions & 128 deletions Documentation/GeneralConventions/CommitMessages.rst

This file was deleted.

28 changes: 12 additions & 16 deletions Documentation/GeneralConventions/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,19 +92,15 @@ be found in the subchapters.

This will look like this: :guilabel:`Admin Tools > Extensions`




**Table of contents**

.. toctree::
:maxdepth: 1

ContentStyleGuide
Glossary
FileStructure
Format
CodingGuidelines
GuidelinesForImages
CommitMessages
Licenses
.. toctree::
:caption: Table of contents
:maxdepth: 1

ContentStyleGuide
Glossary
FileStructure
GuidesXml
Format
CodingGuidelines
GuidelinesForImages
Licenses
3 changes: 1 addition & 2 deletions Documentation/Maintainers/BackportChanges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <general-conventions-commit-messages>`
(as done in the Core):
commit message (as done in the Core):

.. code-block:: text
Expand Down
2 changes: 0 additions & 2 deletions Documentation/Maintainers/Changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions Documentation/WritingDocsOfficial/LocalEditing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,7 @@ 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
phrase your commit messages. Please also add links to resources which might be useful
for a reviewer to know (when appropriate).
Write a short, meaningful commit message describing what changes you have made.

9. Push changes

Expand Down

0 comments on commit b29663d

Please sign in to comment.