This is intended to be a, hopefully simple, framework for leaving PR feedback.
- Changes requested
- Something that must change for PR approval.
Syntax/Standards/Bug- H: I noticed a UI bug when scrolling
<ComponentName />
.
- H: I noticed a UI bug when scrolling
- Changes requested
- Something that should be changed, reason/specifics must be given.
Possibly personal opinion based, may require 3rd party input.
Refactoring comes to mind.- I: Refactor
uvw()
andxyz()
to a hook or function that can be shared between thingOne and thingTwo.
- I: Refactor
- Comment / Possible Changes requested
- Something I would do, but is not necessary.
Think of the classic "nit"
Something small like function naming, use of ternary vs if.- PP: I usually prefer to use action names at the front of functions
function getUserState()
.
- PP: I usually prefer to use action names at the front of functions
- Comment / Purely Discussion
- Something that I would have done differently.
Personal preference but this could require a much larger lift.
These rarely get used because it is really just the reviewer expressing their thoughts.
An ideal usage of this is to educate a junior member of the team and perhaps follow up with a conversation around it post review.- O: I like your idea of how to handle these conditions but I think there may be room for improvement in the future. We can hop on a call this afternoon to talk about other options in terms of structuring these components.
Overall, I like this. There may be some ambiguity between PP / O but I am happy to put this in practice and give it a whirl.