Skip to content

Commit 823e4eb

Browse files
committed
feat(claude): add pr-description command
1 parent d28ce00 commit 823e4eb

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

claude/commands/pr-description.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Create PR Description
2+
3+
Create a concise PR description for the current branch's PR focusing on architecture over implementation details.
4+
5+
Consolidate related details under fewer sections and emphasize high-level decisions rather than exhaustive details.
6+
7+
Reference any design documents or branch commits for deeper context instead of including all details in the description.
8+
9+
**Output the proposed PR description in markdown and use the following structure:**
10+
11+
```markdown
12+
# Overview
13+
14+
[Brief summary of the PR's purpose and scope.]
15+
16+
## Key Changes
17+
18+
- [High-level change 1]
19+
- [Optional: Brief detail or sub-point about change 1.]
20+
21+
[Optional additional context or rationale for change 1.]
22+
23+
- [High-level change 2]
24+
- [Optional: Brief detail or sub-point about change 2.]
25+
26+
[Optional additional context or rationale for change 2.]
27+
28+
## Design Decisions
29+
30+
[Explanation of major design decisions made in the PR, focusing on architecture and rationale rather than implementation specifics.]
31+
32+
## Overall Flow
33+
34+
[Include any relevant architecture diagrams or flowcharts that illustrate the changes made. Written in mermaid syntax; use sequence diagram unless another format is more appropriate.]
35+
```
36+
37+
- Ask me for feedback on the generated description before finalizing it.
38+
- Once approved, ask me if I'd like to copy in markdown format to my clipboard. Copy to clipboard only if I confirm.

0 commit comments

Comments
 (0)