Skip to content

Commit ca86cd6

Browse files
adhorodyskiclaude
andcommitted
Add Code Quality & Standards section to reviewer checklist
Group code quality related items including code patterns, comments, file naming, JSDocs, DRY principles, constants usage, new file documentation, CSS style checks, and component creation standards. Moved items that don't fit this section to end for future organization including localization checks, console error handling, and useOnyx alerts. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 085af72 commit ca86cd6

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

contributingGuides/REVIEWER_CHECKLIST.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,22 @@
2323
- [ ] MacOS: Chrome / Safari
2424
- [ ] MacOS: Desktop
2525
- [ ] For any bug fix or new feature in this PR, I verified that sufficient [unit tests](https://github.com/Expensify/App/blob/main/tests/README.md) are included to prevent regressions in this flow.
26-
- [ ] 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
27-
- [ ] I verified there are no new alerts related to the `canBeMissing` param for `useOnyx`
26+
27+
### Code Quality & Standards
2828
- [ ] I verified proper code patterns were followed (see [Reviewing the code](https://github.com/Expensify/App/blob/main/contributingGuides/PR_REVIEW_GUIDELINES.md#reviewing-the-code))
2929
- [ ] 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`).
3030
- [ ] I verified that comments were added to code that is not self explanatory
3131
- [ ] 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.
32-
- [ ] I verified any copy / text shown in the product is localized by adding it to `src/languages/*` files and using the [translation method](https://github.com/Expensify/App/blob/4510fc76bbf5df699a2575bfb49a276af90f3ed7/src/components/LocaleContextProvider.tsx#L80)
33-
- [ ] I verified all numbers, amounts, dates and phone numbers shown in the product are using the [localization methods](https://github.com/Expensify/App/blob/4510fc76bbf5df699a2575bfb49a276af90f3ed7/src/components/LocaleContextProvider.tsx#L116-L123)
34-
- [ ] I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
3532
- [ ] 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.
3633
- [ ] I verified the JSDocs style guidelines (in [`STYLE.md`](https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#jsdocs)) were followed
3734
- [ ] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
38-
- [ ] 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)
3935
- [ ] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
4036
- [ ] I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
37+
- [ ] If any new file was added I verified that:
38+
- [ ] The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
39+
- [ ] If a new CSS style is added I verified that:
40+
- [ ] A similar style doesn't already exist
41+
- [ ] The style can't be created with an existing [StyleUtils](https://github.com/Expensify/App/blob/main/src/utils/index.ts) function (i.e. `StyleUtils.getBackgroundAndBorderStyle(theme.componentBG`)
4142
- [ ] If a new component is created I verified that:
4243
- [ ] A similar component doesn't exist in the codebase
4344
- [ ] All props are defined accurately and each prop has a `/** comment above it */`
@@ -62,6 +63,11 @@
6263
- [ ] I added `Design` label and/or tagged `@Expensify/design` so the design team can review the changes.
6364
- [ ] If a new page is added, I verified it's using the `ScrollView` component to make it scrollable when more elements are added to the page.
6465
- [ ] I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
66+
- [ ] I verified any copy / text shown in the product is localized by adding it to `src/languages/*` files and using the [translation method](https://github.com/Expensify/App/blob/4510fc76bbf5df699a2575bfb49a276af90f3ed7/src/components/LocaleContextProvider.tsx#L80)
67+
- [ ] I verified all numbers, amounts, dates and phone numbers shown in the product are using the [localization methods](https://github.com/Expensify/App/blob/4510fc76bbf5df699a2575bfb49a276af90f3ed7/src/components/LocaleContextProvider.tsx#L116-L123)
68+
- [ ] I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
69+
- [ ] 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
70+
- [ ] I verified there are no new alerts related to the `canBeMissing` param for `useOnyx`
6571

6672
### Screenshots/Videos
6773
<details>

0 commit comments

Comments
 (0)