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

fix: last backtick should be in inline codeblock when sending a text wrapped with two backticks #565

Merged

Conversation

Antasel
Copy link
Contributor

@Antasel Antasel commented Aug 16, 2023

Fixed Issues

$ Expensify/App#23352
Proposal: Expensify/App#23352 (comment)

Tests

  1. Go to any chat and Send a text wrapped in two backticks
  2. Verify that last backtick is inside of inline code block.

QA

same as test

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 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 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 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
  • 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
web-inline-codeblock.mp4
Mobile Web - Chrome
mobile-web-inline-codeblock-two-backticks.mp4
Mobile Web - Safari
mobile-safari-inline-codeblock-two-backticks.mp4
Desktop
desktop-inline-codeblock-two-backticks.mp4
iOS
ios-inline-codeblock-two-backticks.mp4
Android
android-two-backticks-2023-08-17-160633.mp4

@Antasel Antasel requested a review from a team as a code owner August 16, 2023 16:45
@github-actions
Copy link

github-actions bot commented Aug 16, 2023

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

@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team August 16, 2023 16:45
@Antasel Antasel changed the title fix: last backtick should be in inline codeblock when sending a test wrapped with two backticks fix: last backtick should be in inline codeblock when sending a text wrapped with two backticks Aug 16, 2023
@Antasel
Copy link
Contributor Author

Antasel commented Aug 16, 2023

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

@jasperhuangg jasperhuangg self-requested a review August 17, 2023 17:08
@jasperhuangg
Copy link
Contributor

@Antasel your commits aren't signed

Can you double check that the email on your SSH key is the same as your git config email git config --global user.email

@Antasel Antasel force-pushed the fix-inline-codeblock-with-two-backticks branch from bd03149 to f3fd643 Compare August 17, 2023 17:42
@Antasel
Copy link
Contributor Author

Antasel commented Aug 17, 2023

image

@jasperhuangg now signature is verified

@jasperhuangg
Copy link
Contributor

@Antasel even though the issue is only on Web, I'm realizing that we may want to test this on other platforms, can you provide screen captures on other platforms?

@jasperhuangg jasperhuangg self-requested a review August 17, 2023 20:40
@Antasel
Copy link
Contributor Author

Antasel commented Aug 18, 2023

Screenshots/Videos

Web
web-inline-codeblock.mp4
Mobile Web - Chrome
mobile-web-inline-codeblock-two-backticks.mp4
Mobile Web - Safari
mobile-safari-inline-codeblock-two-backticks.mp4
Desktop
desktop-inline-codeblock-two-backticks.mp4
iOS
ios-inline-codeblock-two-backticks.mp4
Android
android-two-backticks-2023-08-17-160633.mp4

@jasperhuangg could you please check ?

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Aug 18, 2023

It didn't auto assign me as C+ here.

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

Just dummy comment to add me as reviewer so that it will come in my K2. Will do proper review in my morning.

@abdulrahuman5196
Copy link
Contributor

@Antasel you can add the videos to the author's checklist.

@Antasel
Copy link
Contributor Author

Antasel commented Aug 21, 2023

@Antasel you can add the videos to the author's checklist.

it's done.

@jasperhuangg jasperhuangg merged commit 7735de1 into Expensify:main Aug 21, 2023
3 checks passed
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