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

Update CONTRIBUTING.md #13763

Merged
merged 1 commit into from
Dec 21, 2022
Merged

Update CONTRIBUTING.md #13763

merged 1 commit into from
Dec 21, 2022

Conversation

mallenexpensify
Copy link
Contributor

@mallenexpensify mallenexpensify commented Dec 21, 2022

Tiniest change ever, bolded include a link to your Upwork profile. cuz people rarely send ¯_(ツ)_/¯

Details

Fixed Issues

$ GH_LINK
NONE, quick copy change on CONTRIBUTING.md

Tests

Check here to see if include a link to your Upwork profile. is bold.

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

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

Tiniest change ever, bolded   **include a link to your Upwork profile**. cuz people rarely send ¯\_(ツ)_/¯
@mallenexpensify mallenexpensify requested a review from a team as a code owner December 21, 2022 19:25
@mallenexpensify mallenexpensify self-assigned this Dec 21, 2022
@melvin-bot melvin-bot bot requested review from techievivek and removed request for a team December 21, 2022 19:26
@melvin-bot
Copy link

melvin-bot bot commented Dec 21, 2022

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

@techievivek
Copy link
Contributor

techievivek commented Dec 21, 2022

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

Copy link
Contributor

@techievivek techievivek left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for the changes.

@techievivek techievivek merged commit 0040453 into main Dec 21, 2022
@techievivek techievivek deleted the mallenexpensify-patch-2 branch December 21, 2022 20:22
@OSBotify
Copy link
Contributor

✋ 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

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Duration
TTI 820.808 ms → 843.604 ms (+22.797 ms, +2.8%)
runJsBundle 191.710 ms → 195.531 ms (+3.822 ms, +2.0%)
regularAppStart 0.014 ms → 0.015 ms (+0.001 ms, +5.2%)
nativeLaunch 10.344 ms → 9.839 ms (-0.505 ms, -4.9%)
Show details
Name Duration
TTI Baseline
Mean: 820.808 ms
Stdev: 38.401 ms (4.7%)
Runs: 741.4309939998202 761.7782220002264 788.6199329998344 790.4309749999084 790.7703220001422 792.4636550000869 794.7363840001635 794.7716430001892 795.1208990002051 795.3322499999776 795.6246549999341 798.3404740002006 799.5455669998191 801.7120059998706 802.1162539999932 803.2758960002102 815.1807929999195 823.0016089999117 823.7946839998476 824.6799809997901 829.2824579998851 839.9309620000422 854.4432680001482 854.7350800000131 857.1273019998334 857.6410360001028 860.9333899999037 862.4785670000128 895.4863970000297 896.7276180000044 903.5196790001355

Current
Mean: 843.604 ms
Stdev: 32.451 ms (3.8%)
Runs: 794.0857859998941 800.210636000149 802.6814909996465 804.6759599996731 805.2710109995678 806.8728219997138 812.3663739999756 813.4751880001277 818.0053650001064 820.434302999638 823.7379930000752 824.163532000035 824.5703180003911 838.074869999662 838.2594079999253 845.8988880002871 848.7678100001067 850.7721600001678 851.2907940000296 851.393161999993 857.4579739999026 865.2999189998955 869.0946159996092 870.2077940003946 873.0237849997357 877.9068620000035 880.4637930002064 881.4227959997952 881.529870999977 891.732888000086 928.5859989998862
runJsBundle Baseline
Mean: 191.710 ms
Stdev: 19.467 ms (10.2%)
Runs: 160 168 168 172 173 173 175 178 178 182 182 183 184 185 185 187 189 191 192 194 194 195 201 202 209 210 215 218 226 231 243

Current
Mean: 195.531 ms
Stdev: 18.205 ms (9.3%)
Runs: 170 175 175 176 178 179 179 182 183 183 183 184 187 188 190 192 192 192 194 194 197 198 200 205 211 212 215 218 224 224 233 244
regularAppStart Baseline
Mean: 0.014 ms
Stdev: 0.001 ms (7.1%)
Runs: 0.012858000118285418 0.01293900003656745 0.013061000034213066 0.01322399964556098 0.013224999886006117 0.013265000190585852 0.013386999722570181 0.013630999717861414 0.013793999794870615 0.0138349998742342 0.013915999792516232 0.014078000094741583 0.014120000414550304 0.014159999787807465 0.014160000253468752 0.014201000332832336 0.014282000251114368 0.014322999864816666 0.01436399994418025 0.01436399994418025 0.01444500032812357 0.014525999780744314 0.01509599993005395 0.015096000395715237 0.015135999768972397 0.01525900000706315 0.015381000004708767 0.015461999922990799 0.015828999690711498 0.01607299968600273 0.01635799976065755 0.017009000293910503

Current
Mean: 0.015 ms
Stdev: 0.001 ms (6.8%)
Runs: 0.013183999806642532 0.013590999878942966 0.013754000421613455 0.013996999710798264 0.014078999869525433 0.014159999787807465 0.014201000332832336 0.014322999864816666 0.0143630001693964 0.014403999783098698 0.014403999783098698 0.014485999941825867 0.014566999860107899 0.014689999632537365 0.01501499954611063 0.015056000091135502 0.01534000039100647 0.01534000039100647 0.015584000386297703 0.015584999695420265 0.015625 0.015828000381588936 0.015828999690711498 0.015828999690711498 0.015990999527275562 0.01599099999293685 0.016195000149309635 0.0163569999858737 0.016601999290287495 0.01664300076663494 0.0166830001398921 0.01733400020748377
nativeLaunch Baseline
Mean: 10.344 ms
Stdev: 1.962 ms (19.0%)
Runs: 8 8 8 8 8 8 8 8 9 9 9 10 10 10 10 10 10 10 10 11 11 11 11 12 12 12 12 13 13 13 13 16

Current
Mean: 9.839 ms
Stdev: 1.393 ms (14.2%)
Runs: 7 8 8 8 8 9 9 9 9 9 9 9 9 9 9 10 10 10 10 10 11 11 11 11 11 11 12 12 12 12 12

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @techievivek in version: 1.2.43-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @chiragsalian in version: 1.2.43-1 🚀

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.

3 participants