Skip to content

[NoQA] docs: add PR authoring & reviewing standards and best practices guide - #80839

Merged
tgolen merged 4 commits into
Expensify:mainfrom
ikevin127:ikevin127-authorReviewerBestPractices
Feb 4, 2026
Merged

tgolen merged 4 commits into
Expensify:mainfrom
ikevin127:ikevin127-authorReviewerBestPractices

Conversation

@ikevin127

Copy link
Copy Markdown
Contributor

Explanation of Change

As a result of this Slack discussion, this PR adds a new contributor guide (PR_AUTHOR_REVIEWER_BEST_PRACTICES.md) that defines the shared "playbook" for day-to-day standards between PR Authors and C+ Reviewers. The document builds upon existing guidelines and clarifies:

  • Line of Responsibility: The "safety net" principle where C+ acts as the final check, but Authors own quality through comprehensive testing.
  • PR Title Convention: Standardized type: description format (e.g., fix:, feat:, refactor:) for improved searchability and deploy blocker tracking.
  • Explanation of Change: Mandatory requirement for all PRs, even if brief.
  • Review Readiness & WIP/HOLD: Clear criteria for when a PR is ready for review.
  • Testing Split: Authors handle primary verification (happy path); Reviewers focus on destructive and edge-case testing.
  • PR Type-Specific Guidelines: Tailored focus areas for Bug Fixes, New Features, Refactoring, and Package Updates.
  • Unblocking Reviews: Guidance on not blocking reviews for minor lint issues, merge conflicts, or unrelated failing workflows.
  • Comment Resolution: Workaround workflow for C+ tracking comments since they cannot resolve threads directly.

↪️ Additionally, cross-references to the new guide were added to:

  • CONTRIBUTING.md – Step 19 in the "Submit your pull request for final review" section.
  • PR_REVIEW_GUIDELINES.md – Introduction paragraph linking to the comprehensive best practices.
  • HOW_TO_BECOME_A_CONTRIBUTOR_PLUS.md – Added as a requirement for C+ candidates.

@tgolen @mallenexpensify

Fixed Issues

$
PROPOSAL:

Tests

N/A

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (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 is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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)
    • 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 followed the guidelines as stated in the Review Guidelines
  • 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 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.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • 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
  • 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(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

@ikevin127
ikevin127 requested a review from a team as a code owner January 29, 2026 01:47
@melvin-bot
melvin-bot Bot requested review from youssef-lr and removed request for a team January 29, 2026 01:48
@melvin-bot

melvin-bot Bot commented Jan 29, 2026

Copy link
Copy Markdown

@youssef-lr Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@ikevin127 ikevin127 changed the title [NoQA] docs: add PR authoring & reviewing standards and best practices guide [WIP][NoQA] docs: add PR authoring & reviewing standards and best practices guide Jan 29, 2026
| **Minor lint issues** | Note in review, let Author fix in final pass |
| **Merge conflicts** | Review logic/code, Author resolves conflicts after |
| **Unrelated failing workflows** | Continue review if failure is clearly not from this PR |
| **Pre-existing console errors** | Report in Slack `#expensify-bugs`, don't block PR |

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.

Is this for the contributor or C+? If they former they don't have access to #expensify-bugs

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.

C+ Reviewers, will add a change to make this clear 👍

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.

✅

@mallenexpensify mallenexpensify 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.

👍

| Role | Primary Responsibility |
|------|----------------------|
| **PR Author** | Owns the correctness, quality, and testing of their changes. Must demonstrate a clear understanding of what was changed and why. |
| **C+ Reviewer** | Acts as the final safety net. Validates proper testing, catches edge cases, and ensures code quality standards are met. |

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.

Maybe we could add a row for the internal engineer? Something like:

Internal authority to ensure code is secure, compliant, not malicious, or propagating bad code patterns.

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.

✅


## PR Title Convention

All PR titles should follow a consistent format to improve clarity, searchability, and deploy tracking.

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.

We should consider adding this to the AI reviewer rules.

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.

Agreed - should be done after this doc is merged to slowly start enforcing some of the important items listed here.


## Explanation of Change

**Every PR must include an "Explanation of Change" section**, even if the intent seems obvious from the title.

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.

Consider adding:

The best explanations will explain why the change is being done, not just what is changing.

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.

✅


| Requirement | Description |
|------------|-------------|
| ✅ Manual tests documented | Clear, step-by-step testing instructions |

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.

Suggested change
| ✅ Manual tests documented | Clear, step-by-step testing instructions |
| ✅ Manual and QA tests documented | Clear, step-by-step testing instructions |

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.

✅

Before requesting review, the Author must:
1. Run the app locally and verify the fix on **all platforms** (Web, iOS, Android, mWeb)
2. Document specific flows affected by the change
3. Provide comprehensive manual test steps

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.

Suggested change
3. Provide comprehensive manual test steps
3. Provide comprehensive manual and QA test steps

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.

✅

|------|-------------|
| **Primary Verification** | Confirm the fix/feature works as intended (happy path) |
| **Basic Regression Testing** | Verify existing flows still work |
| **Unit Test Coverage** | Add tests to prevent future regressions |

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 this mention something about unit tests for both the positive and negative flows? Such as: test when a parameter exists, and when it doesn't exist. Or test when a boolean is true AND false.

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.

✅

2. Document specific flows affected by the change
3. Provide comprehensive manual test steps
4. Ensure unit tests cover the changed logic
5. Verify CI is green (tests, lint, type checks)

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 mention something about responding to any AI reviewer comments and resolving/dismissing them all?

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.

✅

| **Merge conflicts** | Review logic/code, Author resolves conflicts after |
| **Unrelated failing workflows** | Continue review if failure is clearly not from this PR |
| **Pre-existing console errors** | Report in Slack `#expensify-bugs`, don't block PR |

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.

Maybe we could say something here that if a reviewr's comment starts with "NAB" that it stands for "Not a blocker" so the author knows that it's their decision whether or not to make the change.

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.

✅

- The author cannot confidently explain every change
- Testing becomes unwieldy or impossible to cover comprehensively
- Multiple unrelated changes are bundled together
- The diff is difficult to review in one sitting (rule of thumb: 400+ lines of logic)

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.

Maybe something about number of files too? When I see 20+ files changed I start to 😬

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.

Makes sense, will mention: excluding files like translations / types, with more focus on extensive logic changes in 20+ files changed.

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.

✅

@ikevin127

Copy link
Copy Markdown
Contributor Author

@tgolen All comments addressed ✅ Let me know if there's anything else!

tgolen
tgolen previously approved these changes Feb 3, 2026

@tgolen tgolen 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.

That's it for me!

Comment on lines +247 to +262
### Copy/Translation Changes

**Primary Focus**: Ensuring proper localization and translation approval

When a PR adds or modifies user-facing copy that requires translation, the Author must follow this workflow:

| Step | Action |
|------|--------|
| 1 | **Search for similar strings** in `src/languages/*` to maintain consistency |
| 2 | **Get Spanish translation** using [JaimeGPT](https://chatgpt.com/g/g-2dgOQl5VM-english-to-spanish-translator-aka-jaimegpt) |
| 3 | **Gather screenshots** showing where the proposed copy appears in the product |
| 4 | **Post in [`#expensify-open-source`](https://expensify.enterprise.slack.com/archives/C01GTK53T8Q)** with all the above for internal approval |
| 5 | **Link the Slack message** in your PR for reference |

> [!IMPORTANT]
> Translation approval from Expensify internal team is required before the PR can be merged.

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.

@mallenexpensify Added this based on your request from Slack.

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.

Would it be helpful to hyperlink "JaimeGPT and "Search language files" ?

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.

NABish but this manual process hopefully won't exist for much longer and we can start auto-translating Español

@ikevin127 ikevin127 changed the title [WIP][NoQA] docs: add PR authoring & reviewing standards and best practices guide [NoQA] docs: add PR authoring & reviewing standards and best practices guide Feb 4, 2026
@ikevin127

Copy link
Copy Markdown
Contributor Author

@tgolen 🟢 I think we're good to merge here after latest discussions on Slack.

@tgolen

tgolen commented Feb 4, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • 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 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.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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)
    • 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.ts 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 any new file was added I verified that:
    • 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
  • 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(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@tgolen
tgolen merged commit dd3e6ea into Expensify:main Feb 4, 2026
13 of 14 checks passed
@OSBotify

OSBotify commented Feb 5, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 9.3.13-1 🚀

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

@OSBotify

OSBotify commented Feb 5, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 9.3.15-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/lakchote in version: 9.3.15-10 🚀

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

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.

5 participants