What do you look for when reviewing a PR? Code Review best practices!

[emilyashley]

Hey y'all. Emily Ashley here. I've been trying to get more involved and active with Code Review on Public Lab and I was wondering, what are your peer code review best practices? What's our goal in reviewing? What do you look for? What kind of feedback are you hoping for?

Please share any articles, talks, checklists, or tips and lets collect them here!

---

Resources:

[emilyashley]

For example, right now I'm reading thru this compiled list of articles on awesome code review. If I find any exceptionally helpful I'll add them here 😄

[SidharthBansal]

Hi @emilyashley we see a lot of things while reviewing the prs.

1. Inclusion of Modularity. Have you read a post about it by Jeff? Small feature based prs.
2. Inclusion of tests - Post by Jeff. To ensure correctness of code.
3. Well documented for better understandability and readability
4. Screenshots to check the behaviour
5. Multiple reviews at complex sections like login, integration of lel, editor in plots2, comments etc.

PRs should be squashed before merging so that it is easy to backport to previous plots2 version in case of failure. Best of luck reviewing prs.

[jywarren]

This is great!!! Linking up to possible old but useful resources: #3458, #3563 and #4707