Create Create-A-Report.md #28223

kadiealexander · 2023-09-26T05:57:37Z

$ https://github.com/Expensify/Expensify/issues/311400

QA Testing Steps:

Go to help.expensify.com
Navigate to Expensify Classic > Get Paid Back > Reports > Create A Report
Verify that the article has content and there are no formatting errors

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
- 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(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.

melvin-bot · 2023-09-26T05:58:12Z

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

rushatgabhane · 2023-09-26T06:01:16Z

Please let me know if any testing steps are needed

Yes, I think we should add it so QA can test it after this PR is merged.

Go to help.expensify.com
Expensify Classic > Get Paid Back > Reports > Create A Report
Verify that the article has content

rushatgabhane

@kadiealexander

we forgot to add a .md extension to the article
we also need to paste a completed checklist in the OP so that the PR can be merged

### PR Author Checklist
<!--
This is a checklist for PR authors. Please make sure to complete all tasks and check them off once you do, or else your PR will not be merged!
-->
- [x] I linked the correct issue in the `### Fixed Issues` section above
- [x] I wrote clear testing steps that cover the changes made in this PR
    - [x] I added steps for local testing in the `Tests` section
    - [x] I added steps for the expected offline behavior in the `Offline steps` section
    - [x] I added steps for Staging and/or Production testing in the `QA steps` section
    - [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    - [x] 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)
    - [x] I tested this PR with a [High Traffic account](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md#high-traffic-accounts) against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
- [x] I included screenshots or videos for tests on [all platforms](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md#make-sure-you-can-test-on-all-platforms)
- [x] I ran the tests on **all platforms** & verified they passed on:
    - [x] Android / native
    - [x] Android / Chrome
    - [x] iOS / native
    - [x] iOS / Safari
    - [x] MacOS / Chrome / Safari
    - [x] MacOS / Desktop
- [x] 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)
- [x] I followed proper code patterns (see [Reviewing the code](https://github.com/Expensify/App/blob/main/contributingGuides/PR_REVIEW_GUIDELINES.md#reviewing-the-code))
    - [x] 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`)
    - [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. `myBool && <MyComponent />`.
    - [x] I verified that comments were added to code that is not self explanatory
    - [x] 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.
    - [x] 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/4bd99402cebdf4d7394e0d1f260879ea238197eb/src/components/withLocalize.js#L60)
      - [x] 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:
    - [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the [localization methods](https://github.com/Expensify/App/blob/4bd99402cebdf4d7394e0d1f260879ea238197eb/src/components/withLocalize.js#L60-L68)
    - [x] 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.
    - [x] 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.
    - [x] I verified the JSDocs style guidelines (in [`STYLE.md`](https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#jsdocs)) were followed
- [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- [x] I followed the guidelines as stated in the [Review Guidelines](https://github.com/Expensify/App/blob/main/contributingGuides/PR_REVIEW_GUIDELINES.md)
- [x] 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)
- [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- [x] 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
- [x] I verified that if a function's arguments changed that all usages have also been updated correctly
- [x] If a new component is created I verified that:
    - [x] A similar component doesn't exist in the codebase
    - [x] All props are defined accurately and each prop has a `/** comment above it */`
    - [x] The file is named correctly
    - [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    - [x] The only data being stored in the state is data necessary for rendering and nothing else
    - [x] 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
    - [x] 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)
    - [x] 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`)
    - [x] All JSX used for rendering exists in the render method
    - [x] 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
- [x] If any new file was added I verified that:
    - [x] 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
- [x] If a new CSS style is added I verified that:
    - [x] A similar style doesn't already exist
    - [x] The style can't be created with an existing [StyleUtils](https://github.com/Expensify/App/blob/main/src/styles/StyleUtils.js) function (i.e. `StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)`)
- [x] 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.
- [x] 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)
- [x] 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.
- [x] 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.
- [x] 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.
- [x] 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.
- [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

rushatgabhane · 2023-09-26T21:37:33Z

@kadiealexander we have pushed the article to incorrect folder. It should be placed inside docs/articles

The correct path is docs/articles/expensify-classic/get-paid-back/reports/Create-A-Report.md
Could you please move it here?

…ort.md

kadiealexander · 2023-09-26T21:50:14Z

Good catch @rushatgabhane!! Fixed that one.

rushatgabhane

LGTM! @joelbettner

melvin-bot · 2023-09-26T21:52:19Z

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

melvin-bot · 2023-09-26T21:52:23Z

🎯 @rushatgabhane, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #28282.

Changing "Open report" to "Draft report" as per https://expensify.slack.com/archives/C02QSAC6BJ8/p1695848949618869?thread_ts=1695777130.530819&cid=C02QSAC6BJ8

Adding back in meta info for Jekyll

joelbettner

👍 nice and easy md updates! I didn't see any typos/grammatical errors as I scanned it. @arosiclair all yours.

joelbettner · 2023-09-28T03:59:48Z

Oh, nm. I see that @arosiclair already approved. I'll merge.

melvin-bot · 2023-09-28T04:00:05Z

@joelbettner looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2023-09-28T04:07:10Z

✋ 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 · 2023-09-28T19:16:36Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.75-0 🚀

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

OSBotify · 2023-10-02T17:20:32Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.75-12 🚀

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

OSBotify · 2023-10-02T17:49:07Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.76-0 🚀

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

OSBotify · 2023-10-03T15:50:04Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

Create Create-A-Report.md

8b5b4fd

kadiealexander requested a review from a team as a code owner September 26, 2023 05:57

kadiealexander requested review from rushatgabhane and removed request for a team September 26, 2023 05:57

melvin-bot bot requested a review from joelbettner September 26, 2023 05:58

rushatgabhane suggested changes Sep 26, 2023

View reviewed changes

kadiealexander added 2 commits September 27, 2023 10:19

Rename Create-A-Report to Create-A-Report.md

bf53beb

Change "Policy" to "Workspace"

2a4c669

kadiealexander added 2 commits September 27, 2023 10:49

Update Create-A-Report.md

cacac4c

Delete docs/expensify-classic/hubs/get-paid-back/Reports/Create-A-Rep…

e025e95

…ort.md

rushatgabhane approved these changes Sep 26, 2023

View reviewed changes

melvin-bot bot requested a review from arosiclair September 26, 2023 21:52

melvin-bot bot mentioned this pull request Sep 26, 2023

Payment issue for E/App PR#28223 #28282

Closed

kadiealexander self-assigned this Sep 27, 2023

arosiclair previously approved these changes Sep 28, 2023

View reviewed changes

kadiealexander dismissed arosiclair’s stale review via 2462b99 September 28, 2023 03:37

kadiealexander added 2 commits September 28, 2023 16:37

Update Create-A-Report.md

2462b99

Changing "Open report" to "Draft report" as per https://expensify.slack.com/archives/C02QSAC6BJ8/p1695848949618869?thread_ts=1695777130.530819&cid=C02QSAC6BJ8

Update Create-A-Report.md

0cd006d

Adding back in meta info for Jekyll

joelbettner approved these changes Sep 28, 2023

View reviewed changes

joelbettner merged commit 9d176e8 into main Sep 28, 2023
11 of 12 checks passed

joelbettner deleted the kadiealexander-patch-1 branch September 28, 2023 04:00

melvin-bot bot added the Emergency label Sep 28, 2023

OSBotify mentioned this pull request Sep 28, 2023

Deploy Checklist: New Expensify 2023-09-28 #28412

Closed

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create Create-A-Report.md #28223

Create Create-A-Report.md #28223

kadiealexander commented Sep 26, 2023 •

edited

Loading

melvin-bot bot commented Sep 26, 2023

rushatgabhane commented Sep 26, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

rushatgabhane commented Sep 26, 2023 •

edited

Loading

kadiealexander commented Sep 26, 2023

rushatgabhane left a comment •

edited

Loading

melvin-bot bot commented Sep 26, 2023

melvin-bot bot commented Sep 26, 2023

joelbettner left a comment

joelbettner commented Sep 28, 2023

melvin-bot bot commented Sep 28, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

Create Create-A-Report.md #28223

Create Create-A-Report.md #28223

Conversation

kadiealexander commented Sep 26, 2023 • edited Loading

QA Testing Steps:

PR Author Checklist

melvin-bot bot commented Sep 26, 2023

rushatgabhane commented Sep 26, 2023 • edited Loading

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

rushatgabhane commented Sep 26, 2023 • edited Loading

kadiealexander commented Sep 26, 2023

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented Sep 26, 2023

melvin-bot bot commented Sep 26, 2023

joelbettner left a comment

Choose a reason for hiding this comment

joelbettner commented Sep 28, 2023

melvin-bot bot commented Sep 28, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

kadiealexander commented Sep 26, 2023 •

edited

Loading

rushatgabhane commented Sep 26, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

rushatgabhane commented Sep 26, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading