chore: refine PR description guidance in .claude/CLAUDE.md (#13597)
Keep it short and user-level in the first paragraph
This commit is contained in:
parent
4b8e74b27a
commit
b7ca76a96e
1 changed files with 1 additions and 1 deletions
|
|
@ -102,7 +102,7 @@ Follow the commit convention in `doc/dev/commit_convention.md`.
|
|||
**Title format:** `<type>: <subject>` where type is one of: `feat`, `fix`, `doc`, `style`, `refactor`, `test`, `chore`, `perf`.
|
||||
Subject should use imperative present tense ("add" not "added"), no capitalization, no trailing period.
|
||||
|
||||
**Body format:** The first paragraph must start with "This PR". This paragraph is automatically incorporated into release notes. Use imperative present tense. Include motivation and contrast with previous behavior when relevant. Do NOT use markdown headings (`## Summary`, `## Test plan`, etc.) in PR bodies.
|
||||
**Body format:** The first paragraph must start with "This PR". This paragraph is automatically incorporated into release notes, so keep it short, focus on user-side impact, and avoid implementation-specific wording. Save the implementation details for a follow-up paragraph. Use imperative present tense. Do NOT use markdown headings (`## Summary`, `## Test plan`, etc.) in PR bodies.
|
||||
|
||||
Example:
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue