docs: better reviewer checklist#24
Closed
adhorodyski wants to merge 7 commits into
Closed
Conversation
Reorganize reviewer checklist items to improve clarity by grouping related items under dedicated sections. This commit adds the "Process & Documentation" section and consolidates all process-related checklist items including author checklist verification, issue linking, guideline compliance, and final review completion. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Group all testing-related checklist items under a dedicated section including test steps verification, platform testing, offline testing, screenshot requirements, and unit test coverage. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
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>
Group UI/UX related items including form alignment, design review requirements, scroll view usage, deeplink functionality, and mobile keyboard behavior. Restore missing component impact testing item that was accidentally removed during reorganization. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Group all localization and content-related items including text localization, number/date formatting, and grammar/marketing approval requirements. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Group all component creation guidelines including similarity checks, props documentation, naming conventions, state management, class component binding, JSX organization, and component decomposition. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Move testing-related items (markdown behavior, generic component testing, Storybook verification, component impact testing) to Testing & Verification section. Move code quality items (console error handling, useOnyx alerts) to Code Quality & Standards section. Remove Performance & Technical section to consolidate checklist from 7 to 6 sections while maintaining logical grouping. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reorganize reviewer checklist items to improve clarity by grouping related items under dedicated sections.
Explanation of Change
Fixed Issues
$
PROPOSAL:
Tests
Offline tests
QA Steps
// TODO: These must be filled out, or the issue title must include "[No QA]."
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectioncanBeMissingparam foruseOnyxtoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop