DEV Community

Discussion on: Improve Pull Requests with 5 Habits

Collapse
 
selbekk profile image
selbekk

Great article 🤗 especially your last point - remembering that constructive feedback isn’t necessarily a bad thing is super important.

I’d love to add a few tips of my own:

Tell reviewers how to test your code

When you’re implementing a feature, make sure to tell your reviewers how to test the code that’s being reviewed. Providing a test environment, a test user, and instructions on how to reach your code helps your peers understand your code better!

Review your own PR

Before I add reviewers to my PR, I go through it myself one last time. If there is any code or choices that warrant a comment or explanation, make sure to add those right away.

Add screenshots!

If you’re creating some sort of UI, make sure to add screenshots or gifs of the UI in question. This helps the reviewers visualize your change quicker!

Collapse
 
chantastic profile image
chantastic

excellent additions 🙌

i agree with these 100%
in fact, I actually cut two of them out to get down to five!
decided to leave it for a "get great feedback on a PR" follow-up 😆

"tell reviewers how to test your code" can't be overstated.
i get WAY better feedback after adding a line or two communicating what type of feedback I'm looking for.

those other steps in doule, triple checking your work and ensuring that it's easy to review make for an inviting discussion.

thanks so much for the additions!