docs: clarify lowercase requirement in conventional commits#22445
docs: clarify lowercase requirement in conventional commits#22445tmihoc wants to merge 3 commits into
Conversation
Emphasize that commit descriptions must be lowercase (enforced by CI). Added common mistakes section with examples showing what fails vs passes. This prevents PRs from failing the commitlint check with subject-case errors.
tmihoc
force-pushed
the
3.6-clarify-conventional-commits-lowercase
branch
from
3059d67 to
b5cb02a
Compare
The 'Must use lowercase' requirement with the explicit CI failure warning is sufficient. The Common Mistakes section provided examples but did not add value beyond the clear rule statement.
tmihoc
force-pushed
the
3.6-clarify-conventional-commits-lowercase
branch
from
b5cb02a to
ad1dcc5
Compare
|
The thing we enforce is that the first character (after the tag) is lower case, not the whole message itself. I think you should maybe keep 'Should be lowercase' and add 'First character MUST be..." |
I agree about the must bit but not sure about the should bit: Are you saying we should in general avoid caps, as in, |
jack-w-shaw
left a comment
jack-w-shaw
left a comment
There was a problem hiding this comment.
docs: remove Windows installation instructions would pass CI.
e.g. from https://www.conventionalcommits.org/en/v1.0.0/#specification:
So enforcing the entire description is lowercase is too strong.
However, this is a small detail. I will approve and let you decide how to handle this detail
3 participants
When I point AI agents to our contributing guide, they find the rule about conventional commits but still make mistakes because it is not phrased correctly. This PR updates the phrasing to clarify that commit descriptions must start with lowercase, otherwise the PR fails in the CI.
Forward merge
This PR should be forward merged into
4.0andmain.