pr-creator

# PR Author Guide

Guide for creating PRs that get reviewed quickly and handling the review process effectively.

## PR Creation Workflow

### 1. Prepare the PR

Before creating, ensure:

- Changes are committed and pushed to a feature branch
- Each PR addresses **one thing** (~100 lines ideal, 1000+ too large)
- Related test code is included

### 2. Write the Description

**First line**: Imperative summary that stands alone, respecting conventional commit message format (e.g., "feat(api): add caching to API responses")

**Body**: Context, rationale, and what reviewers need to know. See [references/pr-descriptions.md](references/pr-descriptions.md) for detailed guidance.

### 3. Create and Link to Issue

**IMPORTANT:** When working with issues, use the `uv run scripts/gh_pr.py issue owner/repo <number>` command to fetch issue details with proper authentication rather than relying on other tools.

```bash
# Fetch issue details first for context
uv run scripts/gh_pr.py issue owner/repo 42

# Basic PR creation with the script
uv run scripts/gh_pr.py create owner/repo \
  --title "feat(api): add caching to API responses" \
  --body "## Summary
- Add Redis-based caching for GET endpoints
- Implement cache invalidation on mutations

## Context
API response times average 800ms due to repeated database queries.
This reduces load and improves response times for cached routes.

## Test Plan
- [ ] Verify cache headers in responses
- [ ] Test invalidation after mutations

Closes #42"

# Or read body from a file
uv run scripts/gh_pr.py create owner/repo \
  --title "feat(api): add caching" \
  --body-file /tmp/pr-body.md
```

### 4. Add Labels/Reviewers

```bash
# Full PR creation with labels, reviewers, and assignees
uv run scripts/gh_pr.py create owner/repo \
  --title "feat(api): add caching" \
  --body "Description here" \
  --labels "enhancement,api" \
  --reviewers "username1,username2" \
  --assignees "@me"

# Or add reviewers to existing PR
uv run scripts/gh_pr.py review