[NO QA] Create a Design Doc issue template

[marcaaron]

Coming from this Slack thread

Details

Adds a Design Doc issue template that contributors can use to follow our design doc process more easily.

Fixed Issues

N/A

Tests

N/A

Offline tests

N/A

QA Steps

N/A

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

N/A

[melvin-bot]

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

[stitesExpensify]

Love this idea!

[marcaaron]

Thanks for the awesome suggestions @stitesExpensify - updated !

[stitesExpensify]

Sorry, remembered one more part of our process to make sure everyone is involved

[stitesExpensify]

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

[Beamanator]

Looking great 👍 Have a few suggestions

Just in case you haven't done this yet, we'll need a PR to update this webhook code which automatically closes issues created by contributors: https://github.com/Expensify/Web-Expensify/blob/049602d90e0cf52f96158eb7e818ec3383966d6d/partners/github/webhook.php#L103-L107

[marcaaron]

@Beamanator thanks for the suggestions!

Just in case you haven't done this yet, we'll need a PR to update this webhook code which automatically closes issues created by contributors: https://github.com/Expensify/Web-Expensify/blob/049602d90e0cf52f96158eb7e818ec3383966d6d/partners/github/webhook.php#L103-L107

Feel free to open a PR if you think we need that then go for it.

Added commits from Alex

[stitesExpensify]

Looks great! Can't wait to try it out

[OSBotify]

✋ 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]

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries

Name	Duration
App start TTI	721.694 ms → 769.695 ms (+48.002 ms, +6.7%)
Open Search Page TTI	598.897 ms → 621.311 ms (+22.414 ms, +3.7%)
App start runJsBundle	202.219 ms → 213.813 ms (+11.594 ms, +5.7%)
App start nativeLaunch	20.103 ms → 20.167 ms (+0.063 ms, ±0.0%)
App start regularAppStart	0.018 ms → 0.017 ms (-0.001 ms, -4.1%)

Show details

Name	Duration
App start TTI	Baseline Mean: 721.694 ms Stdev: 28.410 ms (3.9%) Runs: 665.9912339998409 675.7173110004514 686.4388680001721 687.8041139999405 689.5145100001246 691.9046149998903 697.8063089996576 703.0673569999635 704.6290600001812 705.3314800001681 706.7907349998131 710.6546520004049 712.4909610003233 712.5672930004075 723.5811230000108 724.1699740001932 726.327854000032 731.9968729997054 732.4368059998378 734.4055800000206 735.2610849998891 735.3591339997947 737.8589479997754 741.7160550002009 744.845336000435 756.6370050003752 758.7025790000334 759.5158789996058 768.5429170001298 788.7422970002517 Current Mean: 769.695 ms Stdev: 22.036 ms (2.9%) Runs: 724.4034970002249 732.3987069996074 733.7952420003712 740.1657640002668 749.3796049999073 752.2825560001656 757.80950700026 758.5999100003392 758.990825000219 759.0935479998589 759.1871370002627 759.8343559997156 762.7207119995728 765.1630680002272 765.2439430002123 769.3194070002064 769.3691429998726 773.1328060002998 774.6594909997657 777.5268540000543 780.3545300001279 784.575737000443 785.9495550002903 791.0079950001091 793.4772140001878 794.0884149996564 794.5544720003381 798.1038389997557 811.9577639997005 813.7158169997856
Open Search Page TTI	Baseline Mean: 598.897 ms Stdev: 22.836 ms (3.8%) Runs: 554.3824060000479 563.9631749996915 564.0749109992757 564.1595869995654 567.1462819995359 567.5401209993288 572.562663000077 577.4624030003324 585.1566160004586 586.1221519997343 588.6182450000197 595.5247809998691 595.6355790002272 598.9179690005258 599.8449309999123 602.2179359998554 606.0034190006554 606.0431320006028 607.5017900001258 607.703777000308 608.14294399973 609.4740399997681 610.050456000492 614.8749599996954 615.2244060002267 617.7202969994396 621.5815840000287 625.5440270006657 626.5810550004244 627.6619070004672 637.3403730001301 639.9146729996428 Current Mean: 621.311 ms Stdev: 19.080 ms (3.1%) Runs: 580.072224999778 590.1809489997104 590.3335370002314 593.9988200003281 597.6602779999375 601.2991540003568 607.2758789993823 611.5757649997249 611.6807049997151 612.1849369993433 618.5042730001733 622.3452969994396 622.5662850001827 622.7323399996385 624.2303059995174 624.965046999976 625.4017739994451 625.7615569997579 626.0266519999132 627.9586589997634 628.2574869999662 628.4256589999422 632.2084149997681 634.1592610003427 634.7182620000094 634.8702809996903 642.6352129997686 645.6363530000672 655.1486820001155 666.5106210000813
App start runJsBundle	Baseline Mean: 202.219 ms Stdev: 19.971 ms (9.9%) Runs: 161 173 183 184 185 185 186 188 189 189 190 191 195 197 198 198 198 199 203 204 205 205 209 213 217 220 224 228 228 230 238 258 Current Mean: 213.813 ms Stdev: 14.332 ms (6.7%) Runs: 186 194 194 197 199 199 200 201 202 206 207 207 208 210 212 212 212 214 216 217 217 221 222 225 226 226 226 229 235 238 239 245
App start nativeLaunch	Baseline Mean: 20.103 ms Stdev: 1.768 ms (8.8%) Runs: 17 18 18 18 18 19 19 19 19 19 19 19 19 20 20 20 20 20 20 21 21 21 22 22 22 23 23 23 24 Current Mean: 20.167 ms Stdev: 1.267 ms (6.3%) Runs: 18 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 20 20 20 20 20 21 21 21 21 21 22 23 23 23
App start regularAppStart	Baseline Mean: 0.018 ms Stdev: 0.001 ms (8.0%) Runs: 0.015502999536693096 0.015868999995291233 0.015949999913573265 0.015990999527275562 0.016071999445557594 0.016439000144600868 0.0165200000628829 0.01680499967187643 0.01696799974888563 0.01696799974888563 0.0172520000487566 0.017374000512063503 0.01737500075250864 0.017455999739468098 0.017455999739468098 0.017578000202775 0.017578000202775 0.01782300043851137 0.017863000743091106 0.017985000275075436 0.01839200034737587 0.018757999874651432 0.01887999940663576 0.01896199956536293 0.019043000414967537 0.01912400033324957 0.01912499964237213 0.019368999637663364 0.019491000100970268 0.020507999695837498 0.021809999831020832 Current Mean: 0.017 ms Stdev: 0.001 ms (4.4%) Runs: 0.015381000004708767 0.015828999690711498 0.016032000072300434 0.016071999445557594 0.016153999604284763 0.016358000226318836 0.0165200000628829 0.0166830001398921 0.016723000444471836 0.016724000684916973 0.016927000135183334 0.016966999508440495 0.01696799974888563 0.017130999825894833 0.017211999744176865 0.0172520000487566 0.017455999739468098 0.017496999353170395 0.01749700028449297 0.01761799957603216 0.017659000121057034 0.01766000036150217 0.01766000036150217 0.017780999653041363 0.01782199926674366 0.018106999807059765 0.018148000352084637 0.018473000265657902

[OSBotify]

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.2.57-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.57-3 🚀

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