From b7ca76a96e93d5a4daf4effda21734171316a1eb Mon Sep 17 00:00:00 2001 From: Sebastian Ullrich Date: Sat, 2 May 2026 14:02:25 +0200 Subject: [PATCH] chore: refine PR description guidance in `.claude/CLAUDE.md` (#13597) Keep it short and user-level in the first paragraph --- .claude/CLAUDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md index 60ea613dfa..e4e6473f26 100644 --- a/.claude/CLAUDE.md +++ b/.claude/CLAUDE.md @@ -102,7 +102,7 @@ Follow the commit convention in `doc/dev/commit_convention.md`. **Title format:** `: ` 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: ```