[TASK] Clarify Resolves requirement in commit message guide #404
Conversation
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
Make it explicit that 'Resolves:' is required and 'Related:' is optional. The commit-msg hook rejects commits without at least one 'Resolves:' line, but this was not clearly stated in the documentation. Changes: * Mark 'Resolves:' as (REQUIRED) and clarify it is mandatory * Add note that commit-msg hook rejects commits without Resolves * Mark 'Related:' as (OPTIONAL) and clarify it cannot be used alone * Emphasize that at least one 'Resolves:' line is needed This addresses confusion where contributors used only 'Related:' and had their commits rejected.
Releases: main
linawolf
approved these changes
Dec 11, 2025
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.
Recreated from PR #397
This PR is a recreation of #397 after the source fork was accidentally deleted.
Problem
The current documentation doesn't clearly state that
Resolves:is REQUIRED for all commits. Contributors sometimes use onlyRelated:which causes the commit-msg hook to reject their commits with:This confusion was discovered during real-world TYPO3 Core contribution workflow.
Changes
This PR makes the requirement explicit within the existing documentation structure:
Resolves:section with (REQUIRED) labelResolves:Related:section with (OPTIONAL) labelRelated:cannot be used alone - at least oneResolves:line is neededImpact
Contributors will clearly understand:
Resolves:is mandatory (not optional)Related:is supplementary (cannot stand alone)Related:This prevents wasted time debugging commit rejections.
Previous review status on #397: