[Chore][Docs] Refresh commit message convention to match current practice#18242
Merged
Conversation
ruanwenjun
force-pushed
the
dev_wenjun_optimizeClaudemd
branch
from
36317b5 to
0ac4749
Compare
ruanwenjun
force-pushed
the
dev_wenjun_optimizeClaudemd
branch
2 times, most recently
from
d210e6b to
49f8b94
Compare
…tice - Rewrite en/zh commit-message.md: actual type list (Feature/Improvement/Fix/Doc/DSIP/Chore), format [Type-ISSUE_ID][Scope] Subject, Issue ID required for all types except Chore - Update root CLAUDE.md commit-style line and link to the full doc
ruanwenjun
force-pushed
the
dev_wenjun_optimizeClaudemd
branch
from
49f8b94 to
9efa61b
Compare
|
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
2 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.
Was this PR generated or assisted by AI?
YES — drafted with Claude Code assistance; reviewed and verified by the author.
Purpose of the pull request
The current
docs/docs/{en,zh}/contribute/join/commit-message.mdis out of sync with how commits are actually written ondev. The documented format is[DS-ISSUE number][type] subjectwith lowercase types (feat/fix/docs/style/refactor/test/chore), but recent history uses[Type-ISSUE_ID][Scope] Subjectwith capitalized types (Improvement/Fix/Chore/Doc/DSIP/Feature). This PR refreshes the doc to match practice and tightens the rules so contributors can produce consistent, concise messages.Brief change log
docs/docs/en/contribute/join/commit-message.mdand the matchingzhversion:[Type-ISSUE_ID][Scope] Subject(header) + optional body (bulleted change list) + optional footer.devhistory:Feature/Improvement/Fix/Doc/DSIP/Chore.Chore. Subject targets ≤72 chars (soft).PULL_REQUEST_TEMPLATE.md), not the commit body.devcommits.CLAUDE.mdcommit-style line: fix the example format (no space between]and[) and link to the full doc.CLAUDE.local.mdto.gitignoreso contributors using Claude Code can keep personal overrides without pollutinggit status.Verify this pull request
This pull request is documentation only — no test coverage required.