Software Engineering Tidbits

Share this post

Pull Request Outline

www.softwareengineeringtidbits.com

Discover more from Software Engineering Tidbits

Small (or sometimes big) tidbits about software engineering. This is where I share tips and learnings I acquired building, maintaining and supporting software in production at Airbnb, Uber and Microsoft.
Over 6,000 subscribers
Continue reading
Sign in

Pull Request Outline

Georges El Khoury
Mar 22, 2022
3
Share this post

Pull Request Outline

www.softwareengineeringtidbits.com
Share

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.


Mastering Software Engineering Course on Maven

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

View Course


Thanks for reading Software Engineering Tidbits! Subscribe for free to receive new posts and support my work.

3
Share this post

Pull Request Outline

www.softwareengineeringtidbits.com
Share
Comments
Top
New
Community

No posts

Ready for more?

© 2023 Georges El Khoury
Privacy ∙ Terms ∙ Collection notice
Start WritingGet the app
Substack is the home for great writing