These PR reviews points are for the Software Company products, for open source libs PR there could be little deviation from these points.
Pull request review is a collaborative process, all the team members should participate in this, with the thought of improving the code
Keep the PR Small
PR should be as small as possible and very much specific to the problem statement it is trying to solve, avoid to make unnecessary changes in the PR.
Put proper and elboartive PR description
Add proper PR description, screenshot to your PR so that the reviewer can quickly prepare a mental model of the changes, and there will be less back and forth around the PR.
PR Navigation
Add proper comments to your PR so that it is easier for the reviewer to understand the changes better and navigate easily in the PR.
Mention Impacts
Mention about the impacts this PR can make on the existing critical features so the reviewer can help you in identifying any edge case or scenario missed by you.
Be open for suggestions
Always remember PR review is not Criticism, it is collaboration, so take suggestions sportingly and use it as an opportunity to improve your code and skills.
What if you disagree.?
Disagreements will definitely occur during the PR review, but always remember to voice out your opinion in calm and friendly manner and keep it a collaborative positive discussion, rather than a competition of being who is right.
Also, put proper elaborative reasoning behind your disagreement
Be quick in fixing PR comments
Once you have received the feedback on your PR make sure you fix those comments ASAP, if you will delay may be the reviewer loose context of the changes.
Feel free to add your thoughts and practices for PR reviews
Top comments (0)