Pull Request Description Generator
Create the most complete and professional Git merge/pull request description, following established best practices.
Procedure
Phase 1 - Fetch and Analyze Changes
- Get all changes in this branch compared to the default branch since it diverged
- Detect modified files and classify them (e.g., source code, configuration, documentation, tests)
- Identify major functional areas affected (e.g., ui, auth, api, contracts, security)
- Detect breaking changes, dependency updates, and any migration requirements
- Summarize the purpose, major changes, affected components, and any security, dependency, or testing implications
Phase 2 - Generate Merge Request Description
Generate a detailed and professional description in Markdown format:
## Summary
Short high level overview of the purpose.
## Description
Detailed descriptions of all the changes made, their scope, impact and effects.
## Motivation / Context
Why the change is required, including the issue reference if applicable.
## Changes
- [ ] List of major code or feature changes.
- [ ] Highlight of configuration, deployment, or dependency updates.
## Affected Functions
- List `functions` that were added/modified/deleted with brief description
## Security Impact
[icon] Brief summary of security impact
- [ ] List any security-sensitive modifications if any and mitigation strategy if addressed.
## Testing
- [ ] List or summarize test coverage and new test cases.
- [ ] Include steps for manual verification.
## Backward Compatibility
- [icon] Note if any breaking changes exist.
- [icon] Provide migration instructions if needed.
Phase 3 - Refinement
- Use consistent tense and technical clarity
- Enforce line length under 100 characters where possible
- Remove redundant or trivial commit noise (e.g., "fix typo")
- Cross-reference related issues or tickets automatically (Fixes #1234)
Constraints
- Analyze only within the given code. Do not invent missing context or external APIs
1---2name: pr-description3description: Generate professional pull request descriptions from git diff with summary, changes, security impact, and testing notes4---5
6# Pull Request Description Generator
7
8Create the most complete and professional Git merge/pull request description, following established best practices.
9
10## Procedure
11
12### Phase 1 - Fetch and Analyze Changes
131. Get all changes in this branch compared to the default branch since it diverged
142. Detect modified files and classify them (e.g., source code, configuration, documentation, tests)
153. Identify major functional areas affected (e.g., ui, auth, api, contracts, security)
164. Detect breaking changes, dependency updates, and any migration requirements
175. Summarize the purpose, major changes, affected components, and any security, dependency, or testing implications
18
19### Phase 2 - Generate Merge Request Description
20
21Generate a detailed and professional description in Markdown format:
22
23```markdown
24## Summary
25Short high level overview of the purpose.
26
27## Description
28Detailed descriptions of all the changes made, their scope, impact and effects.
29
30## Motivation / Context
31Why the change is required, including the issue reference if applicable.
32
33## Changes
34- [ ] List of major code or feature changes.
35- [ ] Highlight of configuration, deployment, or dependency updates.
36
37## Affected Functions
38- List `functions` that were added/modified/deleted with brief description
39
40## Security Impact
41[icon] Brief summary of security impact
42- [ ] List any security-sensitive modifications if any and mitigation strategy if addressed.
43
44## Testing
45- [ ] List or summarize test coverage and new test cases.
46- [ ] Include steps for manual verification.
47
48## Backward Compatibility
49- [icon] Note if any breaking changes exist.
50- [icon] Provide migration instructions if needed.
51```
52
53### Phase 3 - Refinement
546. Use consistent tense and technical clarity
557. Enforce line length under 100 characters where possible
568. Remove redundant or trivial commit noise (e.g., "fix typo")
579. Cross-reference related issues or tickets automatically (Fixes #1234)
58
59## Constraints
60- Analyze only within the given code. Do not invent missing context or external APIs
majiayu000