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

[HelpDot] Fix List Spacing in Expensify Help #46252

Merged
merged 3 commits into from
Aug 2, 2024

Conversation

rushatgabhane
Copy link
Member

@rushatgabhane rushatgabhane commented Jul 26, 2024

Details

Fixed Issues

$ #44107
PROPOSAL:

Tests

  1. cd docs && npm run createDocsRoutes && bundle exec jekyll serve --livereload --safe
  2. Go to http://127.0.0.1:4000/articles/expensify-classic/connections/xero/Configure-Xero
  3. Verify that nested list items dont have spacing below them
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Screenshot 2024-07-26 at 04 49 31 Screenshot 2024-07-26 at 04 49 27 Screenshot 2024-07-26 at 04 44 55 image

@rushatgabhane rushatgabhane requested a review from a team as a code owner July 26, 2024 01:50
@melvin-bot melvin-bot bot requested review from ahmedGaber93 and removed request for a team July 26, 2024 01:50
Copy link

melvin-bot bot commented Jul 26, 2024

@ahmedGaber93 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
Copy link
Member Author

@ahmedGaber93 kindly approve to assign internal

@rushatgabhane
Copy link
Member Author

@dangrous PR ready to fix it all

Copy link
Contributor

@ahmedGaber93 ahmedGaber93 left a comment

Choose a reason for hiding this comment

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

Copy link

melvin-bot bot commented Jul 26, 2024

We did not find an internal engineer to review this PR, trying to assign a random engineer to #44107 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@dangrous dangrous self-requested a review July 26, 2024 13:57
Copy link
Contributor

@dangrous dangrous 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 to me! I'm going to tag @Expensify/design though too just to give it a once over before merging.

@dangrous dangrous requested a review from a team July 26, 2024 14:57
@dubielzyk-expensify
Copy link
Contributor

Did we add extra padding above the headline?
CleanShot 2024-07-29 at 15 39 05@2x

Feels like that wasn't there before. Otherwise the padding below the lists look good

@shawnborton
Copy link
Contributor

Looking pretty good!

A couple comments from my end:

  • what is the line height being used for bulleted lists and paragraph text in general? I think we want 20px for line height, and I can't tell if the line height might be bigger than that in the screenshtos
  • Do we actually want to consider adding like 4px or 8px below every line in the list? I wonder if that will help the readability of these big blocks of text.

@rushatgabhane
Copy link
Member Author

Did we add extra padding above the headline?

no. that is a result of using h3 i guess

@rushatgabhane
Copy link
Member Author

what is the line height being used for bulleted lists and paragraph text in general? I think we want 20px for line height, and I can't tell if the line height might be bigger than that in the screenshtos

the line-height of the page as a whole is 1.4 (unitless)
so all the child elements compute their own line height based on font size

@shawnborton
Copy link
Contributor

Got it. Could we see it where we add 4px or 8px to the bottom of each li in the lists?

@rushatgabhane
Copy link
Member Author

No padding 4px 8px
image image image

@rushatgabhane
Copy link
Member Author

rushatgabhane commented Jul 29, 2024

8px feels like a bit too much spacing. 4px feel just right to me

what do you think @shawnborton ?

@shawnborton
Copy link
Contributor

4px feels nice but I bet it would feel nicer if we didn't have a global line height of 1.4. I think the idea is that the gaps between li items feels larger than the gaps between lines of text in a paragraph. I bet if you tried the 4px gap when the line height is something more like 1.33 or 20px, it will feel better?

@stitesExpensify stitesExpensify merged commit 306d765 into Expensify:main Aug 2, 2024
9 of 11 checks passed
@dangrous
Copy link
Contributor

dangrous commented Aug 2, 2024

@stitesExpensify was that merge intentional?

@stitesExpensify
Copy link
Contributor

No 😬 I was trying to merge a completely different PR and must have gotten my tabs mixed up. Sorry about that. Do you think we should revert and then revert the revert?

@stitesExpensify
Copy link
Contributor

I'm actually very confused by this.

  1. There were failing checks and the bots didn't post
  2. I wasn't tagged anywhere, and according to my browser I have never been to this PR ever. I searched by URL 😕

@stitesExpensify
Copy link
Contributor

I merged this PR at the exact same time it looks like #46333

@stitesExpensify
Copy link
Contributor

I'm so confused... was this even merged into main??
2024-08-02_14-22-05

@dangrous
Copy link
Contributor

dangrous commented Aug 2, 2024

Yeah they happened two seconds apart, that would be very impressive (looking at our webhook):
image
(top is this one, bottom is #46333)

Not seeing the code in main either. Github must have taken some creative liberties, I wonder if we should tell them?

In the meantime @rushatgabhane do you want to open a new one and play around with @shawnborton's suggestions?

Sorry about that

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.

6 participants