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 for detailed guidance.