Skill: PR Creation

Purpose

Create well-documented pull requests that facilitate code review and maintain clear change documentation.

When to Use

• Feature implementation complete
• Bug fix ready for review
• Code changes need team review
• Merging branches

Tools Used

• git CLI commands
• gh CLI (GitHub CLI)

Configuration

{
  "owner": "{{github.owner}}",
  "repo": "{{github.repo}}",
  "defaultBranch": "{{github.defaultBranch}}"
}

---

PR Creation Flow

Prerequisites

# Ensure you're on feature branch
git branch

# Ensure branch is up to date with remote
git pull origin $(git branch --show-current)

# Ensure base branch is up to date
git fetch origin {{github.defaultBranch}}

# Rebase if needed
git rebase origin/{{github.defaultBranch}}

# Push branch to remote
git push -u origin $(git branch --show-current)

Create PR with gh CLI

# Basic PR creation
gh pr create --title "feat(auth): add login endpoint" --body "Description here"

# Create with template
gh pr create --title "{{title}}" --body-file .github/PULL_REQUEST_TEMPLATE.md

# Create as draft
gh pr create --draft --title "WIP: {{title}}"

# Create with reviewers
gh pr create --title "{{title}}" --reviewer @username1,@username2

# Create with labels
gh pr create --title "{{title}}" --label "feature,needs-review"

# Create with milestone
gh pr create --title "{{title}}" --milestone "v1.0"

# Create targeting specific base branch
gh pr create --base develop --title "{{title}}"

---

PR Templates

Standard PR Template

## Summary

Brief description of the changes and their purpose.

## Changes

- Change 1
- Change 2
- Change 3

## Type of Change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation update

## Related Issues

- Closes #{{issueNumber}}
- Related to #{{relatedIssue}}

## Testing

- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed

## Screenshots (if applicable)

## Checklist

- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] New and existing unit tests pass locally

Feature PR Template

## Feature: {{featureName}}

### Summary
{{briefDescription}}

### User Story
As a {{persona}}, I want to {{action}} so that {{benefit}}.

### Implementation Details

#### Changes Made
{{#each changes}}
- {{change}}
{{/each}}

#### Architecture Decisions
{{architectureNotes}}

### Testing

#### Unit Tests
- {{testFile1}}: {{description}}
- {{testFile2}}: {{description}}

#### Manual Testing Steps
1. {{step1}}
2. {{step2}}
3. {{step3}}

### Screenshots
{{#if hasUI}}
| Before | After |
|--------|-------|
| ![Before](url) | ![After](url) |
{{/if}}

### Related

- Jira: [{{storyKey}}]({{jiraUrl}})
- Design: [Figma]({{figmaUrl}})
- ADR: [{{adrTitle}}]({{adrUrl}})

### Checklist

- [ ] Code follows project conventions
- [ ] Self-reviewed
- [ ] Tests pass
- [ ] Documentation updated
- [ ] Ready for review

Bug Fix PR Template

## Bug Fix: {{bugTitle}}

### Problem
{{problemDescription}}

### Root Cause
{{rootCauseAnalysis}}

### Solution
{{solutionDescription}}

### Changes
{{#each files}}
- `{{file}}`: {{change}}
{{/each}}

### Testing

#### Reproduction Steps (Before Fix)
1. {{step1}}
2. {{step2}}
3. **Bug:** {{bugBehavior}}

#### Verification Steps (After Fix)
1. {{step1}}
2. {{step2}}
3. **Expected:** {{expectedBehavior}}

#### Regression Tests Added
- {{testCase1}}
- {{testCase2}}

### Related

- Bug: [{{bugKey}}]({{jiraUrl}})
- Original Issue: #{{issueNumber}}

### Checklist

- [ ] Bug reproduced before fix
- [ ] Fix verified
- [ ] Regression test added
- [ ] No new issues introduced

---

Branch Naming

Convention

<type>/<ticket>-<description>

Examples:
feature/MDDEV-123-user-authentication
bugfix/MDDEV-456-cart-quantity-fix
hotfix/MDDEV-789-critical-security-patch
chore/MDDEV-100-update-dependencies
docs/MDDEV-200-api-documentation

Creating Feature Branch

# Create and checkout new branch
git checkout -b feature/MDDEV-123-user-auth

# From specific base
git checkout -b feature/MDDEV-123-user-auth origin/develop

---

PR Best Practices

Size Guidelines

Size	Lines Changed	Review Time	Recommendation
XS	< 50	~15 min	Ideal
S	50-200	~30 min	Good
M	200-500	~1 hour	Consider splitting
L	500-1000	~2 hours	Split if possible
XL	> 1000	Hours+	Must split

Keeping PRs Small

## Splitting Large Changes

Instead of one large PR:
❌ "Add user authentication system" (2000 lines)

Split into focused PRs:
✅ PR 1: "Add user model and database migration"
✅ PR 2: "Implement password hashing utility"
✅ PR 3: "Add registration endpoint"
✅ PR 4: "Add login/logout endpoints"
✅ PR 5: "Add authentication middleware"
✅ PR 6: "Add auth documentation"

Self-Review Before Creating

## Self-Review Checklist

Before creating PR:
- [ ] Ran all tests locally
- [ ] Reviewed own diff line by line
- [ ] Removed debug code and console.logs
- [ ] No commented-out code
- [ ] No unnecessary whitespace changes
- [ ] Commit history is clean
- [ ] Branch is up to date with base

---

GitHub CLI Commands

PR Operations

# List open PRs
gh pr list

# View PR details
gh pr view 123

# View PR in browser
gh pr view 123 --web

# Check PR status (checks, reviews)
gh pr status

# Edit PR
gh pr edit 123 --title "New title"

# Add reviewers
gh pr edit 123 --add-reviewer @username

# Add labels
gh pr edit 123 --add-label "bug,priority-high"

# Convert to ready
gh pr ready 123

# Mark as draft
gh pr ready 123 --undo

PR Checks

# View checks status
gh pr checks 123

# Watch checks
gh pr checks 123 --watch

# Re-run failed checks
gh run rerun <run-id>

---

Linking to Jira

In PR Description

## Related Issues

- Implements [MDDEV-123](https://yoursite.atlassian.net/browse/MDDEV-123)
- Fixes [MDDEV-456](https://yoursite.atlassian.net/browse/MDDEV-456)

Log PR to Jira Comment

// Add PR link to Jira story
Atlassian:addCommentToJiraIssue({
  cloudId: "{{jira.cloudId}}",
  issueIdOrKey: "{{storyKey}}",
  commentBody: `🤖 **Developer Agent** - Pull Request Created

**PR:** [#{{prNumber}} - {{prTitle}}]({{prUrl}})
**Branch:** {{branch}}
**Status:** Ready for Review

**Changes:**
{{#each changes}}
- {{change}}
{{/each}}

**Reviewers:** {{reviewers}}`
})

---

Used By Agents

Agent	PR Creation Use
Senior Developer	Creates PRs for complex features
Junior Developer	Creates PRs for implementations
DevOps Engineer	Creates PRs for infrastructure
QA Engineer	May create PRs for test automation

Error Handling

Error	Cause	Resolution
No commits between branches	Nothing to PR	Ensure commits exist
Branch not pushed	Local only	git push -u origin branch
Base branch behind	Merge conflicts likely	Update base branch
Checks failing	CI/CD issues	Fix failures before review