Skip to content

Update PR template to be more explicit about expectations to check off everything#9597

Closed
flodnv wants to merge 1 commit into
mainfrom
flo_PR_TEMPLATE
Closed

Update PR template to be more explicit about expectations to check off everything#9597
flodnv wants to merge 1 commit into
mainfrom
flo_PR_TEMPLATE

Conversation

@flodnv

@flodnv flodnv commented Jun 28, 2022

Copy link
Copy Markdown
Contributor

Details

I have seen some confusions, hopefully this clears them up.
cc @Expensify/contributor-plus

Fixed Issues

https://expensify.slack.com/archives/C01SKUP7QR0/p1655892677571859

Tests

none needed

PR Review Checklist

this is what I am modifying

QA Steps

N/A

@flodnv flodnv requested a review from a team as a code owner June 28, 2022 16:49
@melvin-bot melvin-bot Bot requested review from sketchydroide and removed request for a team June 28, 2022 16:50
- [ ] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers. Check this off if it does not apply.
- [ ] I followed the guidelines as stated in the [Review Guidelines](https://github.com/Expensify/App/blob/main/PR_REVIEW_GUIDELINES.md)
- [ ] I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like `Avatar`, I verified the components using `Avatar` are working as expected)
- [ ] I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like `Avatar`, I verified the components using `Avatar` are working as expected). Check this off if it does not apply.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is something related to this line missing from the C+ checklist?

- [ ] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- [ ] I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
- [ ] If a new component is created I verified that:
- [ ] If a new component is created I verified that (check these off if they do not apply):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, seems you have two different patterns for the same thing:

  1. . Check this off if it does not apply.
  2. (check these off if they do not apply)

Not sure why we can't use (check these off if they do not apply) everywhere
And on the items that have subitems, it's not clear to me if we should only check the parent item, or the parent and all of the children.

@sketchydroide sketchydroide left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a small question
Happy to aprove otherwise

@iwiznia iwiznia left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we instead add this as instructions in the top? ie: instead of adding check this off if it does not apply to every item, let's just say so on the top

@sketchydroide

Copy link
Copy Markdown
Contributor

Not sure, I mean, no body reads is a thing, and this makes sure it's read, I think I prefer to have it in every line

@parasharrajat

Copy link
Copy Markdown
Member

I agree with @iwiznia. Why not add a subtitle to the PR Review Checklist title that says Check off the items that do not apply.

@mananjadhav

mananjadhav commented Jun 29, 2022

Copy link
Copy Markdown
Collaborator

With some of my projects where we don't have such a large checklist, we use the pattern of marking the item checked and striking through to confirm it doesn't apply. Example

[x] Fork the Postman Collection if you have made an edit in the API contract

This gives a clarity to the reviewer as well what the dev thought doesn't apply but probably should've been tested.

@puneetlath

Copy link
Copy Markdown
Contributor

I also agree that adding this at the top would be less clutter than having it in each line. Especially because we'll add new lines and will have to remember to add this to those.

Alternatively, we could add a last checkbox of something like I have checked off every box in the PR author checklist, including those that don't apply to this PR)

@sketchydroide

Copy link
Copy Markdown
Contributor

Oh I like that @puneetlath

@mallenexpensify

Copy link
Copy Markdown
Contributor

With some of my projects where we don't have such a large checklist, we use the pattern of marking the item checked and striking through to confirm it doesn't apply.

I really like @mananjadhav's strikethrough idea because it helps differentiate items that were checked vs those that aren't applicable (where the box is still checked). Can anyone think of any downside to this approach?

@sketchydroide

sketchydroide commented Jul 1, 2022

Copy link
Copy Markdown
Contributor

@mallenexpensify

I really like @mananjadhav's strikethrough idea because it helps differentiate items that were checked vs those that aren't applicable (where the box is still checked). Can anyone think of any downside to this approach?

it doesn't sound like a bad pattern, but I don't know how to apply the strikethrough without editing the text, and that can be a bit annoying to do in such a large list of things to check (and maybe leading to do it on the wrong line).

@flodnv

flodnv commented Jul 5, 2022

Copy link
Copy Markdown
Contributor Author

I agree! Quite obvious in hindsight indeed! I redid the PR: #9698

@flodnv flodnv closed this Jul 5, 2022
@flodnv flodnv deleted the flo_PR_TEMPLATE branch July 5, 2022 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants