docs: fix subject-case rule default from 'always' to 'never'#4703
Merged
escapedcat merged 1 commit intoconventional-changelog:masterfrom Apr 7, 2026
Merged
Conversation
The documentation for the subject-case rule incorrectly stated the default rule as 'always', but the actual default in @commitlint/config-conventional is 'never'. Fixes #4587 Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Review Summary by QodoFix subject-case rule default documentation
WalkthroughsDescription• Corrects subject-case rule default from always to never • Aligns documentation with actual @commitlint/config-conventional implementation Diagramflowchart LR
A["docs/reference/rules.md"] -- "Update rule default" --> B["subject-case: never"]
File Changes1. docs/reference/rules.md
|
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewⓘ The new review experience is currently in Beta. Learn more |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the commitlint rules reference documentation to correctly reflect the default behavior of the subject-case rule, aligning docs/reference/rules.md with the actual default in @commitlint/config-conventional and resolving the mismatch reported in #4587.
Changes:
- Corrected the documented default
subject-caserule fromalwaystoneverin the rules reference.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
Thanks! |
This was referenced Apr 25, 2026
This was referenced Apr 27, 2026
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
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.
Summary
subject-caserule documentation indocs/reference/rules.mdwhich incorrectly stated the default rule asalwaysinstead ofnever@commitlint/config-conventionalisneverwith the value['sentence-case', 'start-case', 'pascal-case', 'upper-case'], meaning subjects must not be in those cases@commitlint/config-conventionalREADME already correctly documents this asneverFixes #4587
Test plan
@commitlint/config-conventional/src/index.tsis"never"@commitlint/config-conventionalREADME already saysneverdocs/reference/rules.mdto match🤖 Generated with Claude Code