Add reviewer checklist to a markdown file #12148

tgolen · 2022-10-26T16:34:30Z

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/239863

Tests

None

Verify that no errors appear in the JS console

QA Steps

Go to https://raw.githubusercontent.com/Expensify/App/main/contributingGuides/REVIEWER_CHECKLIST.md
Verify that the file exists

Verify that no errors appear in the JS console

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

No screenshots necessary since this doesn't touch the code for the app

mananjadhav · 2022-11-01T16:37:36Z

Just got this assigned and checking. @tgolen Quick question, will the reviewer checklist be still a part of the PR Template ?

Are we maintaining them at two places then?

tgolen · 2022-11-01T16:52:04Z

It's eventually only going to exist in this one new place. There will be a period (maybe a week) where it will still exist in both places while I get all the other stuff in place to transition fully to the new location.

Also, just FYI if you were not aware, the checklist is currently already in two places (the PR template and the GH action which checks for completed checklists). So, this PR is actually adding a third checklist for an interim period. However, when it's all said and done, the GH action will also be updated to use the checklist from this new location, so there will only be a single checklist moving forward.

Julesssss

Thanks for the explanation about cleaning this up 👍

Julesssss · 2022-11-01T18:03:08Z

Merging with the failing Author checklist, as it perfectly matches the template

Edit: ignore me, this is the REVIEWER checklist 😅

Julesssss · 2022-11-01T18:03:55Z

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

melvin-bot · 2022-11-01T18:06:03Z

@Julesssss looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2022-11-01T18:11:23Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

mananjadhav · 2022-11-02T02:45:41Z

Thanks for explanation @tgolen. I was just making sure as the template also has an impact on the Github action.

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

OSBotify · 2022-11-02T20:21:39Z

🚀 Deployed to staging by @Julesssss in version: 1.2.23-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

mvtglobally · 2022-11-03T13:10:54Z

looks pass/ Checking off

OSBotify · 2022-11-04T17:12:02Z

🚀 Deployed to production by @Julesssss in version: 1.2.23-9 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

mananjadhav · 2022-11-11T11:40:04Z

@tgolen @Julesssss This is deployed on production for 7 days and eligible for C+ Review payment. Can someone please help with this?

Julesssss · 2022-11-11T11:58:03Z

Yep, see this linked issue.

mananjadhav · 2022-11-11T12:09:12Z

@Julesssss I don't have access to the linked issue.

Julesssss · 2022-11-11T12:13:00Z

Oh, of course, my bad. @laurenreidexpensify will be creating an UpWork issue to pay out and I'll ask her to post the link here on this issue.

mananjadhav · 2022-11-14T04:01:11Z

Okay thanks for the update @Julesssss.

laurenreidexpensify · 2022-11-15T11:09:13Z

Upwork link https://www.upwork.com/jobs/~01e4ff23131f276953

mananjadhav · 2022-11-15T11:13:22Z

Applied @laurenreidexpensify

laurenreidexpensify · 2022-11-16T14:32:42Z

@mananjadhav has been paid 👍🏽

mananjadhav · 2022-11-16T14:47:33Z

Thanks @laurenreidexpensify

Add reviewer checklist to a markdown file

f222fa7

tgolen self-assigned this Oct 26, 2022

Add a title to the checklist and screenshot section

a6eab23

tgolen marked this pull request as ready for review November 1, 2022 16:32

tgolen requested a review from a team as a code owner November 1, 2022 16:32

melvin-bot bot requested review from Julesssss and rushatgabhane and removed request for a team November 1, 2022 16:33

tgolen requested review from a team and removed request for a team November 1, 2022 16:33

melvin-bot bot requested review from mananjadhav and thienlnam November 1, 2022 16:33

thienlnam approved these changes Nov 1, 2022

View reviewed changes

Julesssss approved these changes Nov 1, 2022

View reviewed changes

Julesssss merged commit 00f2766 into main Nov 1, 2022

Julesssss deleted the tgolen-add-reviewer-checklist-markdown branch November 1, 2022 18:05

melvin-bot bot added the Emergency label Nov 1, 2022

tgolen removed the Emergency label Nov 2, 2022

OSBotify mentioned this pull request Nov 2, 2022

Deploy Checklist: New Expensify 2022-11-02 #12397

Closed

44 tasks

Julesssss removed the request for review from rushatgabhane November 15, 2022 11:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add reviewer checklist to a markdown file #12148

Add reviewer checklist to a markdown file #12148

tgolen commented Oct 26, 2022 •

edited

Loading

mananjadhav commented Nov 1, 2022

tgolen commented Nov 1, 2022

Julesssss left a comment

Julesssss commented Nov 1, 2022 •

edited

Loading

Julesssss commented Nov 1, 2022

melvin-bot bot commented Nov 1, 2022

OSBotify commented Nov 1, 2022

mananjadhav commented Nov 2, 2022

OSBotify commented Nov 2, 2022

mvtglobally commented Nov 3, 2022

OSBotify commented Nov 4, 2022

mananjadhav commented Nov 11, 2022

Julesssss commented Nov 11, 2022

mananjadhav commented Nov 11, 2022

Julesssss commented Nov 11, 2022

mananjadhav commented Nov 14, 2022

laurenreidexpensify commented Nov 15, 2022

mananjadhav commented Nov 15, 2022

laurenreidexpensify commented Nov 16, 2022

mananjadhav commented Nov 16, 2022

Add reviewer checklist to a markdown file #12148

Add reviewer checklist to a markdown file #12148

Conversation

tgolen commented Oct 26, 2022 • edited Loading

Fixed Issues

Tests

QA Steps

PR Author Checklist

PR Reviewer Checklist

Screenshots

mananjadhav commented Nov 1, 2022

tgolen commented Nov 1, 2022

Julesssss left a comment

Choose a reason for hiding this comment

Julesssss commented Nov 1, 2022 • edited Loading

Julesssss commented Nov 1, 2022

melvin-bot bot commented Nov 1, 2022

OSBotify commented Nov 1, 2022

mananjadhav commented Nov 2, 2022

OSBotify commented Nov 2, 2022

mvtglobally commented Nov 3, 2022

OSBotify commented Nov 4, 2022

mananjadhav commented Nov 11, 2022

Julesssss commented Nov 11, 2022

mananjadhav commented Nov 11, 2022

Julesssss commented Nov 11, 2022

mananjadhav commented Nov 14, 2022

laurenreidexpensify commented Nov 15, 2022

mananjadhav commented Nov 15, 2022

laurenreidexpensify commented Nov 16, 2022

mananjadhav commented Nov 16, 2022

tgolen commented Oct 26, 2022 •

edited

Loading

Julesssss commented Nov 1, 2022 •

edited

Loading