What to look for in a PR review
Show What are you strict about when reviewing code? What do you always point out in your peer reviews? Top comments (5)Sort discussion:
Collapse Expand
Alexandru-Dan Pop I'm Software Engineer who loves working with Javascript, React, and Node.js. 👨💻 I'm also a big Typescript fan! 🚀
• May 19 '20
Code structure & common patterns usedIs the code structured correctly and following the same trends and patterns as the rest of the application? Code qualityDoes it follow good namig conventions? MaintainabilityIf i think certain parts are badly written or too complex, unreadable, or could be simplified I might suggest alternatives. Note to self when reviewing codeCan you automate more to make some general mistakes occur less often?
Carlos Roso Author Software Engineer. Former digital nomad at Toptal. Open sorcerer. Thoughts on career growth, remote work, and web dev.
Author • May 19 '20
Great learnings from here. I like how you strive for codebase consistency (is this similar to what we have elsewhere) and also for automation (avoid style discussions by introducing a common linter). Thanks for sharing! Collapse Expand
Carlos Roso Author Software Engineer. Former digital nomad at Toptal. Open sorcerer. Thoughts on career growth, remote work, and web dev.
Author • May 18 '20
FP So whenever I see functions like this...
... I would point out how functions should have the least amount of side-effects and find a cleaner way to achieve this outside of the function. Comments Error handling
caelinsutch Cofounder of Bytes Robotics. Passionate about creating products that improve quality of life and integrate seamlessly into everyday environments.
• May 21 '20
Readability Lint it please Top Level
Documentation
Carlos Roso Author Software Engineer. Former digital nomad at Toptal. Open sorcerer. Thoughts on career growth, remote work, and web dev.
Author • May 24 '20
All in for ripping off one-liners here too! Code of Conduct • Report abuseFor further actions, you may consider blocking this person and/or reporting abuse What should I look for when reviewing PR?Anyone can review a PR as long as enough context is given. PR shows changes in the files which have been modified by the author.. What does this PR do? ... . Does this PR do what it's supposed to do? ... . Does this PR do what it's supposed to do correctly? ... . Is the code readable?. What makes a good PR review?Your review should be clear, constructive and consistent. Clarity is important because authors will not be able to respond to your concerns if they don't fully understand what they are. Reviews are most helpful if they don't just criticise, but also make constructive suggestions for how concerns may be resolved.
What key things would you look for when reviewing a code?What to look for in a code review. Design. The most important thing to cover in a review is the overall design of the CL. ... . Functionality. Does this CL do what the developer intended? ... . Complexity. Is the CL more complex than it should be? ... . Tests. ... . Naming. ... . Comments. ... . Style. ... . Consistency.. |