[TASK] Document commit message conventions for contributors - #548
Merged
Conversation
EditLocal.rst only said "write a short, meaningful commit message." Document the actual convention: [TASK]/[BUGFIX]/[FEATURE] prefix, a why-focused body, Signed-off-by/Assisted-by trailers, references to related changelog entries/Gerrit changes/issues, and how Releases: lines relate to automatic backporting. Also refreshed the Releases: examples in BackportChanges.rst and ReviewPolicy.rst from 12.4/11.5 to 14.3/13.4. Verified with the full Docker render pipeline. Assisted-by: Claude Sonnet 5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
Contributor
|
Why not just following conventional commit messages format? https://www.conventionalcommits.org/ It seems commonly accepted and known, you do not need to describe it here, except saying "conventional commits required" |
Member
Author
|
We follow the conventions from the TYPO3 Core, also the conventions you linked do not have rules about AI usage, while TYPO3 adopted them and also no rules about backports. |
Releases:main
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
EditLocal.rst only said "write a short, meaningful commit message."
Document the actual convention: [TASK]/[BUGFIX]/[FEATURE] prefix, a
why-focused body, Signed-off-by/Assisted-by trailers, references to
related changelog entries/Gerrit changes/issues, and how Releases:
lines relate to automatic backporting. Also refreshed the Releases:
examples in BackportChanges.rst and ReviewPolicy.rst from 12.4/11.5
to 14.3/13.4.
Verified with the full Docker render pipeline.
Assisted-by: Claude Sonnet 5 noreply@anthropic.com
Signed-off-by: Lina Wolf