Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New US small business playbook #15306

Merged
merged 17 commits into from
Feb 21, 2023
Merged

New US small business playbook #15306

merged 17 commits into from
Feb 21, 2023

Conversation

davidcardoza
Copy link
Contributor

Mirroring a similar PR as #14953

Tracking GH: https://github.com/Expensify/Expensify/issues/262473

!-- If necessary, assign reviewers that know the area or changes well. Feel free to tag any additional reviewers you see fit. -->

Details

Add a new article in the Playbooks hub in the help site.

Fixed Issues

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

Tests

  1. Open the Playbooks hub page (http://127.0.0.1:4000/hubs/playbooks on dev and https://help.expensify.com/hubs/playbooks on prod).
  2. Click on Expensify Playbook for US-Based VC-Backed Startups and verify the article is loaded correctly.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Test steps

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 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 correct English and 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
    • 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 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 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 have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

The expensify help site only works on web

Web Screenshot 2023-02-14 at 13 39 02 Screenshot 2023-02-14 at 13 39 11

Mirroring a similar PR as #14953
@davidcardoza davidcardoza requested a review from a team February 20, 2023 18:38
@davidcardoza davidcardoza self-assigned this Feb 20, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 20, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@melvin-bot melvin-bot bot requested review from Luke9389 and parasharrajat and removed request for a team February 20, 2023 18:38
@MelvinBot
Copy link

@parasharrajat @Luke9389 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]

@zsgreenwald zsgreenwald requested a review from a team as a code owner February 20, 2023 18:45
I removed the #Overview section at the top.
@melvin-bot melvin-bot bot requested review from deetergp and mananjadhav and removed request for a team February 20, 2023 18:45
@MelvinBot
Copy link

@mananjadhav @deetergp 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]

@mananjadhav
Copy link
Collaborator

@davidcardoza I don't think this needs a C+ review. Feel free to unassign or let me know if you need me to review.

@parasharrajat
Copy link
Member

Same from me.

Copy link
Contributor

@deetergp deetergp 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, just caught a few typos during my read-through.

SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
SmallbusinessPlaybook Outdated Show resolved Hide resolved
@deetergp
Copy link
Contributor

@parasharrajat @mananjadhav C+ reviews are not necessary for this, thanks for pointing it out 👍

davidcardoza and others added 10 commits February 21, 2023 13:24
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
@davidcardoza
Copy link
Contributor Author

changes accepted

davidcardoza and others added 5 commits February 21, 2023 13:27
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
Co-authored-by: Scott Deeter <deetergp@users.noreply.github.com>
@davidcardoza
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@deetergp
Copy link
Contributor

deetergp commented Feb 21, 2023

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 tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • 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 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 correct English and 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 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.js 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(themeColors.componentBG)
  • 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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@deetergp deetergp merged commit 7b5fbe1 into main Feb 21, 2023
@deetergp deetergp deleted the davidcardoza-patch-1 branch February 21, 2023 22:11
@github-actions
Copy link
Contributor

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Duration
App start TTI 726.374 ms → 737.572 ms (+11.199 ms, +1.5%)
App start runJsBundle 202.156 ms → 203.656 ms (+1.500 ms, +0.7%)
App start nativeLaunch 19.452 ms → 19.517 ms (+0.066 ms, ±0.0%)
App start regularAppStart 0.014 ms → 0.015 ms (+0.001 ms, +3.9%)
Open Search Page TTI 624.029 ms → 612.865 ms (-11.165 ms, -1.8%)
Show details
Name Duration
App start TTI Baseline
Mean: 726.374 ms
Stdev: 30.898 ms (4.3%)
Runs: 667.9155449999962 675.5822499999776 687.2151200000662 689.2552420001011 689.8115439999383 693.4399669999257 693.6726969999727 701.7312610000372 703.2160080000758 705.877860999899 711.7502890001051 711.9943860000931 718.0001169999596 721.8764440000523 721.910118999891 722.6590170001145 724.0074529999401 728.518133000005 737.1286440000404 739.1745470000897 740.1750580000225 740.9844710000325 741.4523809999228 742.7796189999208 742.913198000053 755.0672720000148 755.1330369999632 763.0697200000286 770.8400860000402 771.4078200000804 782.5001379998866 792.9042779998854

Current
Mean: 737.572 ms
Stdev: 32.393 ms (4.4%)
Runs: 680.57154299994 695.2996410001069 701.7741419998929 703.478092999896 704.1267299999017 704.6086609999184 706.4263589999173 711.3877979998942 711.9116930000018 714.386058999924 717.3741649999283 723.0645979999099 724.8949339999817 727.0445910000708 727.3964190001134 730.9475020000245 738.3641059999354 739.5417100000195 740.3996460000053 740.8489029998891 746.585252000019 746.6063069999218 746.6326760000084 751.8525320000481 761.9433079999872 763.9689829999115 770.0930319998879 774.3869610000402 777.0312139999587 801.5444569999818 808.661337000085 809.1636840000283
App start runJsBundle Baseline
Mean: 202.156 ms
Stdev: 21.550 ms (10.7%)
Runs: 166 172 176 177 177 177 179 180 181 183 189 193 198 199 200 201 201 202 207 209 210 210 214 218 219 222 223 232 235 235 240 244

Current
Mean: 203.656 ms
Stdev: 16.676 ms (8.2%)
Runs: 179 181 182 183 184 185 190 190 190 194 194 197 197 198 199 201 202 202 204 207 208 210 210 210 211 223 225 225 229 231 236 240
App start nativeLaunch Baseline
Mean: 19.452 ms
Stdev: 1.623 ms (8.3%)
Runs: 17 17 18 18 18 18 18 18 18 19 19 19 19 19 19 19 19 19 19 19 20 20 20 20 21 21 21 22 23 23 23

Current
Mean: 19.517 ms
Stdev: 1.611 ms (8.3%)
Runs: 17 18 18 18 18 18 18 19 19 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 21 21 22 24 24
App start regularAppStart Baseline
Mean: 0.014 ms
Stdev: 0.001 ms (4.0%)
Runs: 0.0129399998113513 0.013672000030055642 0.013712000101804733 0.0139979999512434 0.014037999790161848 0.014038000022992492 0.014079000102356076 0.014119000174105167 0.014160000020638108 0.01424099993892014 0.01432300009764731 0.014362999936565757 0.014404000015929341 0.014484999934211373 0.014485999941825867 0.014527000021189451 0.014567000092938542 0.014689000090584159 0.014689000090584159 0.014771000016480684 0.014851999934762716 0.0148930000141263 0.014933000085875392 0.014973999932408333 0.015177000081166625 0.01525900000706315 0.016032000072300434

Current
Mean: 0.015 ms
Stdev: 0.001 ms (6.9%)
Runs: 0.013142999960109591 0.013264999957755208 0.013347000116482377 0.013509000185877085 0.014078999869525433 0.014160000020638108 0.014160000020638108 0.014241000171750784 0.014322999864816666 0.014404000015929341 0.014485000167042017 0.014567000092938542 0.014607999939471483 0.014688999857753515 0.014689999865368009 0.014770000008866191 0.014973999932408333 0.015055000083521008 0.01513600000180304 0.015217999927699566 0.01566500007174909 0.015666000079363585 0.015787999844178557 0.0157880000770092 0.01599099999293685 0.015992000000551343 0.01607199991121888 0.016398000065237284 0.0165200000628829 0.0165200000628829 0.016601999988779426 0.017089999979361892
Open Search Page TTI Baseline
Mean: 624.029 ms
Stdev: 23.834 ms (3.8%)
Runs: 589.973876999924 590.6019289998803 591.3019619998522 597.0179449999705 598.1410320000723 599.61014899984 600.8212080001831 606.5452070001047 606.5787760000676 606.6055100001395 610.7044280001428 613.5596929998137 615.0297450001817 616.6802169999573 617.8979489998892 618.1390390000306 620.5408119999338 623.4388429999817 623.6722420000006 626.5283200000413 626.645751999924 628.1839189999737 628.8159589997958 633.9510909998789 637.2537839999422 640.584228000138 641.6278890001122 647.1223959999625 648.3062340000179 658.1874589999206 670.9208170000929 678.3118900000118 679.6730150000658

Current
Mean: 612.865 ms
Stdev: 20.956 ms (3.4%)
Runs: 573.9974769998807 575.9099129999522 579.777425999986 580.6337079999503 586.9704989998136 590.4877929999493 594.1784669999033 596.035116000101 598.9244790000375 599.9755460000597 605.3854170001578 607.2224129999522 608.1412349999882 608.6379799998831 608.7206220000517 611.9475910000037 614.0861819998827 614.3955079999287 616.2043049999047 617.7974849999882 618.46875 621.0776369997766 621.662597999908 624.8791919997893 625.0522060000803 631.738078000024 632.3712160000578 635.2699789998587 635.45259599993 641.609701000154 644.4380700001493 644.5240480001085 658.5679939999245

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/deetergp in version: 1.2.76-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

@davidcardoza
Copy link
Contributor Author

@deetergp should I be seeing this in help.Expensify.com now that it's in prod?

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.

7 participants