PR_review_template.md

FEATURE_NAME

• PR_LINK

What goal does this code accomplish?

this might be the "What problem are you solving" section of a PR

How does it accomplish this goal?

this might be the "How did you solve it" section of a PR

What are the key scenarios, and are they captured?

Are enough edge cases covered for comfort?

Are you (the writer) writing reviews in a friendly tone?

• good reviews ask open-ended questions instead of making strong or opinionated statements.
• offer workarounds that might work better for the situation without insisting those are the only way to proceed
• Additional PR reviewing notes: https://gist.github.com/brianzhou13/f1fff4f72f1f93abd25ec2000f553f36

Tech Notes:

---

If you can't understand the code, stop the review and leave a comment. It's likely that there are other engineers who would get stumped by it. Ensure that the code that is being introduced is maintainable

Are there any classes/functions that are hard too read? If so, suggest they should be refactored

Business Notes:

---

Interesting equity-related/like notes

Questions:

TODOs from author:

Don't accept PRs that degrade the health of the codebase

Praises:

points of praise