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

[No QA] Fix missing space in docs #15374

Merged
merged 1 commit into from
Feb 23, 2023
Merged

[No QA] Fix missing space in docs #15374

merged 1 commit into from
Feb 23, 2023

Conversation

rushatgabhane
Copy link
Member

@rushatgabhane rushatgabhane commented Feb 22, 2023

Details

just fixing a small typo in docs

Fixed Issues

$ N.A.
PROPOSAL: N.A.

Tests

  • 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

@rushatgabhane rushatgabhane requested a review from a team as a code owner February 22, 2023 21:42
@melvin-bot melvin-bot bot requested review from robertjchen and removed request for a team February 22, 2023 21:43
@MelvinBot
Copy link

@robertjchen 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 rushatgabhane changed the title [No QA] Fix missign space in docs [No QA] Fix missing space in docs Feb 22, 2023
Copy link
Contributor

@robertjchen robertjchen left a comment

Choose a reason for hiding this comment

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

👍

@robertjchen
Copy link
Contributor

robertjchen commented Feb 23, 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

@robertjchen robertjchen merged commit b3aae44 into Expensify:main Feb 23, 2023
@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 702.484 ms → 733.796 ms (+31.312 ms, +4.5%)
Open Search Page TTI 602.888 ms → 615.205 ms (+12.317 ms, +2.0%)
App start runJsBundle 190.600 ms → 198.533 ms (+7.933 ms, +4.2%)
App start regularAppStart 0.014 ms → 0.015 ms (+0.001 ms, +6.3%)
App start nativeLaunch 19.774 ms → 19.323 ms (-0.452 ms, -2.3%)
Show details
Name Duration
App start TTI Baseline
Mean: 702.484 ms
Stdev: 18.359 ms (2.6%)
Runs: 673.0879670009017 674.2253760006279 681.6068099997938 683.0119620002806 686.3404510002583 688.2056329995394 688.789659999311 692.2200109995902 692.4340930003673 693.6657439991832 694.8149580005556 695.2949560005218 696.2890690006316 696.8671269994229 702.497587999329 703.0665739998221 704.9270670004189 706.4254969991744 709.0083639994264 712.3168310001493 715.5969319995493 718.7714530006051 720.6495719999075 721.7003889996558 730.7656980007887 731.1123489998281 753.3703630007803

Current
Mean: 733.796 ms
Stdev: 32.251 ms (4.4%)
Runs: 674.7796659991145 679.8527489993721 691.6838470008224 695.181196000427 695.7018500007689 696.7524529993534 700.1526399999857 703.2822549995035 707.4205709993839 711.900612000376 714.4850260000676 716.3098220005631 721.5181370005012 723.932417999953 735.436405999586 736.189882999286 737.3167860005051 739.65663100034 739.8056429997087 744.0257670003921 745.5238809995353 756.0212740004063 756.3966080006212 759.7845929991454 760.4038740005344 763.5995220001787 770.8980519995093 772.7670809999108 772.7963219992816 776.1597569994628 778.5126540008932 803.2082529999316
Open Search Page TTI Baseline
Mean: 602.888 ms
Stdev: 14.100 ms (2.3%)
Runs: 570.4237879998982 582.0675460007042 584.9837239999324 586.452840000391 589.4273690003902 591.0562749989331 592.5211990009993 593.1003019995987 594.5752770006657 595.5111900009215 595.656576000154 596.6741949990392 597.1001379992813 598.9493820015341 601.0457770004869 601.4767249990255 603.9438879992813 605.1091719996184 605.4558109994978 607.9536129999906 608.3297129999846 608.5219320002943 612.4401859994978 612.465046999976 612.7763270009309 614.3852949999273 615.1416829992086 622.4934899993241 623.1396490000188 632.9563809987158 633.3887529987842

Current
Mean: 615.205 ms
Stdev: 18.144 ms (2.9%)
Runs: 586.1633710004389 587.4843350015581 588.3047289997339 595.746175000444 597.1800950001925 598.0301520004869 599.4422210007906 600.3981119990349 604.2519129998982 604.8313400000334 605.9299729987979 607.8818359989673 608.0885419994593 608.3144940007478 608.9872239995748 611.3892419990152 612.125406999141 612.8592130001634 615.7259929999709 616.3670249991119 616.397828001529 618.1965340003371 625.7384440004826 626.4860429987311 628.4676510002464 635.6234949994832 636.8059090003371 637.9463709983975 642.1549889985472 644.4163819998503 648.8773189987987 655.9417319986969
App start runJsBundle Baseline
Mean: 190.600 ms
Stdev: 14.641 ms (7.7%)
Runs: 163 171 172 172 175 176 176 180 181 181 182 189 189 191 191 191 192 192 192 193 197 199 199 201 202 203 209 214 218 227

Current
Mean: 198.533 ms
Stdev: 14.214 ms (7.2%)
Runs: 177 178 181 181 181 186 186 187 189 190 193 195 195 196 197 197 197 199 205 205 205 205 205 207 208 209 220 221 224 237
App start regularAppStart Baseline
Mean: 0.014 ms
Stdev: 0.001 ms (7.1%)
Runs: 0.012654999271035194 0.013061000034213066 0.013061000034213066 0.013102998957037926 0.013182999566197395 0.013225000351667404 0.013387000188231468 0.013467999175190926 0.013508999720215797 0.013508999720215797 0.013508999720215797 0.013590000569820404 0.013753000646829605 0.013915998861193657 0.013915998861193657 0.013915998861193657 0.013957001268863678 0.013996999710798264 0.013996999710798264 0.014364000409841537 0.014485999941825867 0.014812000095844269 0.014932999387383461 0.014932999387383461 0.01505499891936779 0.015178000554442406 0.015257999300956726 0.015299001708626747 0.015341000631451607 0.015706000849604607 0.0157880000770092 0.017170999199151993

Current
Mean: 0.015 ms
Stdev: 0.001 ms (7.4%)
Runs: 0.013102000579237938 0.013631999492645264 0.013670999556779861 0.013671999797224998 0.013957001268863678 0.014078998938202858 0.014160001650452614 0.014201000332832336 0.014363998547196388 0.014404000714421272 0.014485999941825867 0.01464799977838993 0.014729999005794525 0.014852000400424004 0.01517699845135212 0.015217998996376991 0.01521800085902214 0.015258999541401863 0.015300000086426735 0.01534000039100647 0.015381000936031342 0.015544001013040543 0.015583999454975128 0.015625 0.015951000154018402 0.01603200100362301 0.016276000067591667 0.016682999208569527 0.017090000212192535 0.01729400083422661 0.01782199926674366
App start nativeLaunch Baseline
Mean: 19.774 ms
Stdev: 1.384 ms (7.0%)
Runs: 18 18 18 18 18 18 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 20 21 21 21 21 21 21 22 23 23

Current
Mean: 19.323 ms
Stdev: 1.329 ms (6.9%)
Runs: 17 18 18 18 18 18 18 18 18 18 19 19 19 19 19 19 19 19 20 20 20 20 20 20 20 20 21 21 21 22 23

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.2.76-1 🚀

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

@rushatgabhane rushatgabhane deleted the patch-1 branch February 23, 2023 05:00
@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 ✅

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.

4 participants