- Published on
Advent of Pull Requests Best Practice - Day 8
- Authors
- Name
- Nico Prananta
- @2co_p
Following up from yesterday's post about setting up a PR template, today I'm diving into what your template should look like. Think of it as your project's customizable toolkit. Here's a quick guide on what to include:
- Objective: Keep it short and sweet. What's this PR aiming to do?
- Background/Context: Any key info or related links that give some backstory.
- Implementation Details: The nitty-gritty of your approach and any big tech decisions you’ve made.
- Testing Performed: Outline the tests you ran to make sure everything's working as it should.
- Screenshots/Videos: Super helpful for UI changes, so everyone can see what's new.
- Special Instructions for Reviewers: Point out areas you want your reviewers to focus on or any tricky bits.
Remember, a solid PR template like this can really streamline your review process, reduce unnecessary back-and-forth, and ensure everyone's on the same page. It's all about keeping your PRs consistent and thorough.
📖 Early Bird Offer
Need more insights like this? Jump on our early bird offer and grab your copy for 40% less! This deal is flying off the shelves, so hurry! 🎉