Skip to content

[No QA] Update coding standards index and normalize clean-react ids#93990

Merged
rlinoz merged 2 commits into
Expensify:mainfrom
callstack-internal:docs-coding-standards-index
Jun 19, 2026
Merged

[No QA] Update coding standards index and normalize clean-react ids#93990
rlinoz merged 2 commits into
Expensify:mainfrom
callstack-internal:docs-coding-standards-index

Conversation

@kacper-mikolajczak

@kacper-mikolajczak kacper-mikolajczak commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

This PR does two related things to the coding-standards skill: it brings the index back in sync with the rule files, and it normalizes the clean-react rule ids to a single convention.

The coding-standards index (.claude/skills/coding-standards/SKILL.md) lists every rule in both a categories table and a quick reference. Several rules added to .claude/skills/coding-standards/rules/ after the index was written were never added to it, including an entire UI category that had no entry at all (not even the pre-existing UI-1 rule).

This PR updates the index so it reflects every rule file in the directory:

  • Adds a UI category row to the categories table.
  • Adds the missing quick-reference entries: CONSISTENCY-7..11, CLEAN-REACT-PATTERNS-6..9, and a new UI section with UI-1..3.
  • Expands the Consistency and Clean React Patterns category descriptions to mention the newly covered areas (localization, file naming, JSDoc, prop typing, function components).

It also normalizes the four newest clean-react rules, which used the id prefix CLEAN-REACT-, to the established CLEAN-REACT-PATTERNS- convention used by the other rules and the category. This updates their ruleId frontmatter, their section headers, the category table prefix, and the index entries. The filenames already follow the shared clean-react-N convention and are unchanged.

Verified that every file in rules/ is now referenced by the index and that every rules/*.md link resolves.

Fixed Issues

$ #94020
PROPOSAL:

Tests

  1. Confirm no errors appear in the JS console (N/A - this PR changes a markdown index file only).
  2. Open .claude/skills/coding-standards/SKILL.md and confirm the categories table includes a UI row.
  3. Confirm the quick reference lists CONSISTENCY-7..11, CLEAN-REACT-6..9, and UI-1..3.
  4. Verify every rule file is indexed and every link resolves:
    • for f in .claude/skills/coding-standards/rules/*.md; do grep -q "$(basename "$f")" .claude/skills/coding-standards/SKILL.md || echo "MISSING: $f"; done
    • grep -oE 'rules/[a-z0-9-]+\.md' .claude/skills/coding-standards/SKILL.md | sort -u | while read p; do [ -f ".claude/skills/coding-standards/$p" ] || echo "BROKEN: $p"; done
    • Both loops should print nothing.
  • Verify that no errors appear in the JS console

Offline tests

N/A - this change updates a documentation index file only; it does not affect runtime or offline behavior.

QA Steps

N/A - there is no user-facing or staging behavior to QA. The change updates the coding-standards index file only.

  • 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 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 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)
  • 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)
  • 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.
  • 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.

Screenshots/Videos

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

The coding standards index listed only the rules that existed when it
was written. Several rules added since then were missing from both the
categories table and the quick reference, including an entire UI
category that had no entry at all.

Add a UI category and list the new UI, consistency, and clean-react
rules so the index reflects every rule file in the directory.
@kacper-mikolajczak kacper-mikolajczak changed the title Add newly added rules to the coding standards index [No QA] Add newly added rules to the coding standards index Jun 19, 2026
@kacper-mikolajczak

kacper-mikolajczak commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

@Julesssss this is the follow-up you asked for - adding the new rules to the coding-standards index. It turned out the index was missing more than just the UI rules: there was no UI section at all (even the existing UI-1 was unlisted), plus the new CONSISTENCY-7..11 and CLEAN-REACT-6..9 weren't indexed. This adds a UI category and lists every rule, and I verified every rule file is now referenced and every link resolves.

The four newest clean-react rules use the id prefix CLEAN-REACT- while the older ones use CLEAN-REACT-PATTERNS-. I will also include fix on this here.

@kacper-mikolajczak

Copy link
Copy Markdown
Contributor Author

CC @rlinoz as @Julesssss is OOO today 🙏

The four newest clean-react rules used the id prefix CLEAN-REACT- while
the established rules and the category use CLEAN-REACT-PATTERNS-. Align
the four new rules (ruleId frontmatter and section headers) with the
existing convention, and update the index and category table to match.
Filenames already follow the shared clean-react-N convention, so they
are unchanged.
@kacper-mikolajczak kacper-mikolajczak changed the title [No QA] Add newly added rules to the coding standards index [No QA] Update coding standards index and normalize clean-react ids Jun 19, 2026
@rlinoz rlinoz self-requested a review June 19, 2026 14:06

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

Thanks!

@kacper-mikolajczak kacper-mikolajczak marked this pull request as ready for review June 19, 2026 14:44
@kacper-mikolajczak kacper-mikolajczak requested a review from a team as a code owner June 19, 2026 14:44
@melvin-bot melvin-bot Bot requested review from daledah and removed request for a team June 19, 2026 14:44
@melvin-bot

melvin-bot Bot commented Jun 19, 2026

Copy link
Copy Markdown

@daledah 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]

@rlinoz rlinoz removed the request for review from daledah June 19, 2026 14:45
@rlinoz

rlinoz commented Jun 19, 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 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 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)
  • 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)
  • 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.
  • 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

@rlinoz

rlinoz commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Sorry for the ping, no need to review, thanks!

@rlinoz rlinoz merged commit 278af47 into Expensify:main Jun 19, 2026
16 of 18 checks passed
@OSBotify

Copy link
Copy Markdown
Contributor

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.4.16-1 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/blimpich in version: 9.4.16-5 🚀

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.

3 participants