Pull Request Outline

A good outline for a pull request.

Clear and concise title

Description:
What?
Why? + Context + Ticket
How is it tested?
Reviewers

Help the code reviewers help you.

Add screenshots
Add curl requests/responses
Add line comments on code diffs when more context is needed.

---

Software Engineering from the Frontlines Course on Maven

If you liked this article, I will be teaching a “Software Engineering from the Frontlines” course on Maven where I will teach hard-learned lessons I acquired developing large-scale products at companies such as Uber, Airbnb, and Microsoft.

---