Back to Skills

write-pr-description

verified

Use when creating pull requests to write clear, structured PR descriptions that help reviewers understand changes.

View on GitHub

Marketplace

eveld-claude

eveld/claude

Plugin

workflows

Repository

eveld/claude
3stars

skills/write-pr-description/SKILL.md

Last Verified

January 23, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/eveld/claude/blob/main/skills/write-pr-description/SKILL.md -a claude-code --skill write-pr-description

Installation paths:

Claude
.claude/skills/write-pr-description/
Powered by add-skill CLI

Instructions

# Write PR Description

Create structured pull request descriptions that provide context for reviewers.

## Structure

```markdown
## Summary
[1-2 sentence overview]

## What Changed
- [Bullet point 1]
- [Bullet point 2]
- [Bullet point 3]

## Why
[Explanation of why this change was needed]

## Testing
### Automated
- [x] Unit tests pass
- [x] Integration tests pass
- [x] Linting passes

### Manual
- [x] [Specific manual test performed]
- [x] [Another manual verification]

## Screenshots
[If UI changes]
![Description](url)

## Related Issues
Closes #123
Refs #456
```

## Sections

### Summary
- 1-2 sentences explaining the PR at a high level
- What is being added/fixed/changed
- Why it matters

### What Changed
- Bullet list of specific changes
- Focus on "what" not "how"
- Group related changes together

### Why
- Business context or technical motivation
- Problem being solved
- Why this approach was chosen

### Testing
Split into Automated and Manual:

**Automated**:
- Commands that were run
- All tests that pass
- CI/CD checks

**Manual**:
- Specific manual testing performed
- Edge cases verified
- Performance testing

### Screenshots (if applicable)
- Before/after comparisons for UI changes
- Error states
- Different screen sizes/browsers

### Related Issues
- Link to tickets: `Closes #123`
- Link to related PRs: `Refs #456`
- Link to documentation

## Example

```markdown
## Summary
Adds JWT token refresh mechanism to prevent unexpected session expiration. Tokens are automatically refreshed 5 minutes before expiry.

## What Changed
- Added token refresh endpoint `/api/auth/refresh`
- Implemented automatic refresh timer in auth middleware
- Added token expiry checking logic
- Updated auth context to handle refresh flow
- Added tests for refresh scenarios

## Why
Users were experiencing unexpected logouts when their sessions expired during active use. This caused data loss and poor UX. Automatic token refresh keeps sessions alive as long as users are active.

## 

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
2989 chars