tomoasleep-pr-style

A clear pull request description uses a consistent What, How, and Why template to articulate design rationale, trade-offs, and actionable context. This structured approach ensures readers can instantly skim changes and understand decision logic without extra back-and-forth.

The best way to link issues in a PR description is using a dedicated pattern for the issue URL within the What section. This connects code changes directly to tracked issues, providing immediate context and improving project traceability across reviews.

To reduce back-and-forth during code reviews, format your template with practical notes on verification, dependencies, and open questions alongside the What, How, and Why sections. This provides reviewers with all necessary contextual information upfront before assessing changes.

Yes, you can apply a single PR style template across multiple projects to enforce consistent communication and structure. Using a standardized What, How, and Why format ensures all teams draft descriptions with uniform clarity, issue linkage, and design rationale.

You need to include a Quick Start section in your pull request documentation when you want to provide a concise overview of the change before detailing the What, How, and Why. It helps reviewers grasp the core context immediately before reading the deeper design rationale.