Skip to content

[NO QA] Update and rename Add-comments-and-attachments-to-a-report.md to Edit…#57878

Merged
neil-marcellini merged 7 commits intomainfrom
maddylewis-patch-9
Mar 7, 2025
Merged

[NO QA] Update and rename Add-comments-and-attachments-to-a-report.md to Edit…#57878
neil-marcellini merged 7 commits intomainfrom
maddylewis-patch-9

Conversation

@maddylewis
Copy link
Contributor

@maddylewis maddylewis commented Mar 5, 2025

…-and-Submit-Expense-Reports.md

https://github.com/Expensify/Expensify/issues/473907

Explanation of Change

Fixed Issues

$
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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 / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 verified the translation was requested/reviewed 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 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 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.js 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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(themeColors.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 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.
  • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videosundefined

@maddylewis maddylewis self-assigned this Mar 5, 2025
@maddylewis maddylewis requested a review from a team as a code owner March 5, 2025 19:30
@maddylewis maddylewis moved this to CRITICAL in [#whatsnext] #retain Mar 5, 2025
@melvin-bot
Copy link

melvin-bot bot commented Mar 5, 2025

Concierge reviewer checklist:

  • I have verified the accuracy of the article
    • The article is within a hub that makes sense, and the navigation is correct
    • All processes, screenshots, and examples align with current product behavior.
    • All links within the doc have been verified for correct destination and functionality.
  • I have verified the readability of the article
    • The article's language is clear, concise, and free of jargon.
    • The grammar, spelling, and punctuation are correct.
    • The article contains at least one image, or that an image is not necessary
  • I have verified the formatting of the article
    • The article has consistent formatting (headings, bullet points, etc.) with other HelpDot articles and that aligns with the HelpDot formatting standards.
    • The article has proper text spacing and breaks for readability.
  • I have verified the article has the appropriate tone and style
    • The article's tone is professional, friendly, and suitable for the target audience.
    • The article's tone, terminology, and voice are consistent throughout.
  • I have verified the overall quality of the article
    • The article is not missing any information, nor does it contain redundant information.
    • The article fully addresses user needs.
  • I have verified that all requested improvements have been addressed

For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member?

@melvin-bot melvin-bot bot requested review from neil-marcellini and strepanier03 and removed request for a team March 5, 2025 19:30
@melvin-bot
Copy link

melvin-bot bot commented Mar 5, 2025

@neil-marcellini @strepanier03 One of you needs to 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]

@maddylewis maddylewis removed the request for review from strepanier03 March 5, 2025 19:31
@OSBotify
Copy link
Contributor

OSBotify commented Mar 5, 2025

A preview of your ExpensifyHelp changes have been deployed to https://3e8e6a4c.helpdot.pages.dev ⚡️

@maddylewis
Copy link
Contributor Author

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good. A few small things stood out to me so I want to make sure they're intentional.

- **To**: Approver’s name(s).
- **CC**: Additional recipients (comma-separated).
- **Memo**: Additional notes.
- **Attach PDF**: Attach a report copy (optional).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Attach a report copy" I find that wording a little confusing. What about something like "Attach a PDF for additional context"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this article had a readability score of 9 and an AI parsing score of 9.5 so i think its fine to leave as-is.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What kind of PDF would you have that is a copy of the report? I don't think we should allow the rating of an AI to overrule a human opinion outright.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make this not a blocker, but I would like to see it reworded.

@maddylewis
Copy link
Contributor Author

replied and resolved comments! 👍

@maddylewis
Copy link
Contributor Author

ill take a look at the redirect file to get that cleaned up and ping ya once this is ready to merge.

@maddylewis
Copy link
Contributor Author

@neil-marcellini - i think ive resolved the redirects issue. not sure if anything else is required for resolving the comments you left, but this should be good to merge as long as the redirects file is good to go.

and then for the next couple of weeks, @stephanieelliott and i are optimizing the rest of the site for AgentZero parsing, so no need to scrutinize the updates too much ! communicating so that you don't do extra work that is not required of you! ty ty.

@neil-marcellini
Copy link
Contributor

i think ive resolved the redirects issue.

What was the redirects issue? Either way good to hear and your updates there look fine.

and then for the next couple of weeks, @stephanieelliott and i are optimizing the rest of the site for AgentZero parsing, so no need to scrutinize the updates too much ! communicating so that you don't do extra work that is not required of you! ty ty.

It's my job to review all the changes in PRs. It doesn't take me too much time. I think we still want the help site to work well and make sense throughout this process, so might as well give it a human read through.

@neil-marcellini
Copy link
Contributor

neil-marcellini commented Mar 6, 2025

No reviewer checklist is required for this help site change. @maddylewis feel free to address the non blocking comment and merge, address it in a follow up, or ignore for now, merge and we can fix it someday if a user is ever confused.

@maddylewis
Copy link
Contributor Author

@neil-marcellini - i believe a PR reviewer checklist is required for these! want to add that when you have a chance? tysm!

image

@neil-marcellini neil-marcellini merged commit d690889 into main Mar 7, 2025
8 of 11 checks passed
@neil-marcellini neil-marcellini deleted the maddylewis-patch-9 branch March 7, 2025 17:21
@github-project-automation github-project-automation bot moved this from CRITICAL to DONE in [#whatsnext] #retain Mar 7, 2025
@neil-marcellini
Copy link
Contributor

Yes the check fails but I'm adding a note explaining why it's irrelevant. It's easier and makes more sense to me than pasting a completed checklist that I didn't actually follow.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.1.11-1 🚀

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

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.12-7 🚀

platform result
🤖 android 🤖 true ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: DONE

Development

Successfully merging this pull request may close these issues.

3 participants