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

Move the Small Business playbook to the correct location #15601

Merged
merged 2 commits into from
Mar 1, 2023

Conversation

deetergp
Copy link
Contributor

@deetergp deetergp commented Mar 1, 2023

Details

This PR moved the US Based Small Business playbook to the correct location.

Fixed Issues

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

Tests

  1. Follow the steps in this SO to compile the Jekyll for help.expensify.com
  2. Verify that the link for Expensify Playbook for US-Based Small Businesses shows under the Playbooks menu item.
    Screenshot 2023-03-01 at 12 20 09 PM and click on it
  3. Verify that the correct playbook loads after clicking on it.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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 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.
  • 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/Videos

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

@deetergp deetergp requested a review from a team as a code owner March 1, 2023 20:09
@deetergp deetergp self-assigned this Mar 1, 2023
@melvin-bot melvin-bot bot requested review from amyevans and sobitneupane and removed request for a team March 1, 2023 20:10
@MelvinBot
Copy link

@sobitneupane @amyevans 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]

@deetergp
Copy link
Contributor Author

deetergp commented Mar 1, 2023

This does not require a C+ review so I'm going to un-assign you @sobitneupane.

@deetergp deetergp removed the request for review from sobitneupane March 1, 2023 20:18
@amyevans
Copy link
Contributor

amyevans commented Mar 1, 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 ![Screenshot 2023-03-01 at 3 42 06 PM](https://user-images.githubusercontent.com/7277067/222260560-fdf293db-11e5-4a2d-abfe-32d65c64fbf9.png)
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@amyevans
Copy link
Contributor

amyevans commented Mar 1, 2023

These jest tests haven't been completing recently, I'm going to just merge.

@amyevans amyevans merged commit bbe5c1d into main Mar 1, 2023
@amyevans amyevans deleted the scott-moveSmallBusinessPlaybook branch March 1, 2023 22:44
@OSBotify
Copy link
Contributor

OSBotify commented Mar 1, 2023

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

@github-actions
Copy link
Contributor

github-actions bot commented Mar 1, 2023

Performance Comparison Report 📊

Significant Changes To Duration

Name Duration
Open Search Page TTI 607.926 ms → 662.803 ms (+54.876 ms, +9.0%) 🔴
Show details
Name Duration
Open Search Page TTI Baseline
Mean: 607.926 ms
Stdev: 15.743 ms (2.6%)
Runs: 581.4501949995756 582.572103000246 589.8414719998837 590.9007980003953 593.8803719999269 593.9396970001981 595.5884600002319 595.8948969999328 598.3009440004826 598.3903000000864 599.4502359991893 599.6880289996043 600.160157000646 600.3428150005639 603.2381189996377 605.8333329996094 606.4864499997348 607.9790449999273 608.0132250003517 608.2479259995744 614.0480550006032 616.4792479993775 617.4758720006794 618.1717529995367 618.7860110001639 619.0796719994396 622.1578369997442 622.4816490001976 625.0086270002648 626.8139650002122 635.8101809993386 657.1338299997151

Current
Mean: 662.803 ms
Stdev: 17.063 ms (2.6%)
Runs: 622.3258870001882 630.8208829993382 639.6470130002126 640.6760660000145 644.2744140001014 650.8017589999363 651.012532999739 652.7974450001493 654.6198730003089 655.8739419998601 655.8930670004338 658.0570879997686 658.6835529999807 658.8079840000719 661.0739339999855 661.6297209998593 663.7712819995359 668.0010990006849 668.366822000593 668.9199220007285 669.9026700006798 669.9986980007961 672.1374920001253 673.9000249998644 674.4544680006802 676.8512369999662 678.1503909993917 681.6240650005639 692.1744389999658 693.0769039997831 698.5639650002122

Meaningless Changes To Duration

Show entries
Name Duration
App start TTI 702.794 ms → 718.647 ms (+15.853 ms, +2.3%)
App start nativeLaunch 19.867 ms → 20.438 ms (+0.571 ms, +2.9%)
App start regularAppStart 0.014 ms → 0.014 ms (+0.001 ms, +4.7%)
App start runJsBundle 198.000 ms → 197.375 ms (-0.625 ms, ±0.0%)
Show details
Name Duration
App start TTI Baseline
Mean: 702.794 ms
Stdev: 29.771 ms (4.2%)
Runs: 640.2133879996836 648.0815939996392 650.5643170000985 668.9662779998034 671.9500949997455 674.6466250000522 676.180428000167 684.7805239995942 687.0164850000292 691.8764079995453 692.6577180000022 696.4603420002386 696.6681450000033 696.7188200000674 698.2042209999636 702.4584100004286 703.4125279998407 706.3734560003504 708.2744129998609 710.3465369995683 713.2086359998211 717.2762179998681 719.5848700003698 724.1994970003143 732.7724320003763 735.85252100043 739.2035490004346 744.9185389997438 748.6598880002275 750.6782099995762 754.4071779996157

Current
Mean: 718.647 ms
Stdev: 35.207 ms (4.9%)
Runs: 671.3331530001014 677.7989720003679 679.3845089999959 681.7392960004508 683.8797700004652 684.369318000041 685.0254319999367 686.5185850001872 687.4954190002754 698.5474549997598 700.2830119999126 702.1642850004137 703.120476000011 704.9172080000862 707.2939200000837 711.7636759998277 712.030376999639 712.3275009999052 715.8042130004615 716.7888839999214 719.9775599995628 721.3728099996224 725.7270160000771 738.3622409999371 751.1427610004321 752.4518189998344 754.2368700001389 763.0288030002266 770.1731949998066 771.3057890003547 799.7314360002056 806.6137279998511
App start nativeLaunch Baseline
Mean: 19.867 ms
Stdev: 1.648 ms (8.3%)
Runs: 17 18 18 18 18 18 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 21 21 21 21 22 23 23 23 23

Current
Mean: 20.438 ms
Stdev: 2.120 ms (10.4%)
Runs: 18 18 18 18 18 18 18 19 19 19 19 19 19 19 19 20 20 20 21 21 21 22 22 22 22 22 23 23 24 24 24 25
App start regularAppStart Baseline
Mean: 0.014 ms
Stdev: 0.001 ms (4.6%)
Runs: 0.012655000202357769 0.012736000120639801 0.012897999957203865 0.012980000115931034 0.012980000115931034 0.013061000034213066 0.013061999343335629 0.013224000111222267 0.013225000351667404 0.013305999338626862 0.013387000188231468 0.013426999561488628 0.01342800073325634 0.0134680001065135 0.013469000346958637 0.01355000026524067 0.01358999963849783 0.013590999878942966 0.013632000423967838 0.01371300034224987 0.013753000646829605 0.013793000020086765 0.013996999710798264 0.014200999401509762 0.014240999706089497 0.014526000246405602 0.014566999860107899 0.0148930000141263 0.015300000086426735

Current
Mean: 0.014 ms
Stdev: 0.001 ms (6.8%)
Runs: 0.01269499957561493 0.012695999816060066 0.012776999734342098 0.01318300049751997 0.013224000111222267 0.013386999256908894 0.013387000188231468 0.013508999720215797 0.013631000183522701 0.0138349998742342 0.013957000337541103 0.013957000337541103 0.014078999869525433 0.014120000414550304 0.014159999787807465 0.014159999787807465 0.014200999401509762 0.014241999946534634 0.014281999319791794 0.01444500032812357 0.014485000632703304 0.014526000246405602 0.014566999860107899 0.01460800040513277 0.014689999632537365 0.015054999850690365 0.015381000004708767 0.015422000549733639 0.016195000149309635 0.0163569999858737 0.016479999758303165
App start runJsBundle Baseline
Mean: 198.000 ms
Stdev: 21.573 ms (10.9%)
Runs: 161 162 170 171 172 173 174 181 182 182 185 188 188 188 190 193 201 202 205 205 209 212 215 219 224 224 225 225 225 226 229 230

Current
Mean: 197.375 ms
Stdev: 21.352 ms (10.8%)
Runs: 163 165 169 174 174 176 178 178 178 184 186 187 191 192 193 195 200 201 202 202 203 203 207 207 209 212 217 218 224 238 244 246

@github-actions github-actions bot added the DeployBlockerCash This issue or pull request should block deployment label Mar 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 1, 2023

@Expensify/mobile-deployers 📣 Please look into this performance regression as it's a deploy blocker.

@OSBotify
Copy link
Contributor

OSBotify commented Mar 2, 2023

🚀 Deployed to staging by https://github.com/amyevans in version: 1.2.78-0 🚀

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

@roryabraham
Copy link
Contributor

There is an approximately 0% chance that this caused an E/App regression. It would be great to not run the E/App performance tests on HelpDot PRs, since we actually pay for large runner time

@roryabraham roryabraham removed the DeployBlockerCash This issue or pull request should block deployment label Mar 6, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.2.78-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 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.

5 participants