Writing Good PRs
← Back to Writing for Engineers
A good PR description includes context (why this change), what changed, how to test, and screenshots for UI changes. Small, focused PRs are easier to review. Link to the issue/ticket. Make the reviewer’s job easy.
Related
- Commit Messages (commit-level documentation)
- Technical Writing Principles (apply to PRs)