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

feat(comm): extend application update notification component to match new BASE #3725

Conversation

alexvcasillas
Copy link
Contributor

@alexvcasillas alexvcasillas commented Jul 14, 2023

COMM-2458 & COMM-2634

Description

When it comes to displaying the user that there’s a mandatory update and that they need to refresh whether they like it or not, we should be using the ApplicationUpdateNotification component provided by Picasso that follows BASE. But this component is not extensible enough and it does not give room for customization as we have various requirements that need to be fulfilled in order to be able to satisfy the requirements that we’re aiming for with the Force Refresh initiative.

How to test

BASE design 👉🏻 https://www.figma.com/file/vVoOW3YNKJkvRV3RAMPF3Y/Talent-Portal-Library?type=design&node-id=4612-37156&mode=design&t=r0mYhMpZA9tD0VjW-0

  • Access Storybook
  • Check that all of the acceptance criteria in the attached Jira Ticket is met
  • CI should be 💚

Screenshots

Before. After.
image
image image image image image image image image

Development checks

  • Add changeset according to guidelines (if needed)
  • Read CONTRIBUTING.md and Component API principles
  • Make sure that additions and changes on the design follow Toptal's BASE design, and it's been already discussed with designers at #-base-core
  • Annotate all props in component with documentation
  • Create examples for component
  • Ensure that deployed demo has expected results and good examples
  • Ensure the changed/created components have not caused accessibility issues. How to use accessibility plugin in storybook.
  • Self reviewed
  • Covered with tests
  • Design Specs have reached BASE

Breaking change

  • codemod is created and showcased in the changeset
  • n/a test alpha package of Picasso in StaffPortal

All development checks should be done and set checked to pass the
GitHub Bot: TODOLess action

PR commands

List of available commands:

  • @toptal-bot run package:alpha-release - Release alpha version
  • @toptal-anvil ping reviewers - Ping FX team for review
PR Review Guidelines

When to approve? ✅

You are OK with merging this PR and

  1. You have no extra requests.
  2. You have optional requests.
    1. Add nit: to your comment. (ex. nit: I'd rename this variable from makeCircle to getCircle)

When to request changes? ❌

You are not OK with merging this PR because

  1. Something is broken after the changes.
  2. Acceptance criteria is not reached.
  3. Code is dirty.

When to comment (neither ✅ nor ❌)

You want your comments to be addressed before merging this PR in cases like:

  1. There are leftovers like unnecessary logs, comments, etc.
  2. You have an opinionated comment regarding the code that requires a discussion.
  3. You have questions.

How to handle the comments?

  1. An owner of a comment is the only one who can resolve it.
  2. An owner of a comment must resolve it when it's addressed.
  3. A PR owner must reply with ✅ when a comment is addressed.

@alexvcasillas alexvcasillas requested a review from a team as a code owner July 14, 2023 08:09
@changeset-bot
Copy link

changeset-bot bot commented Jul 14, 2023

🦋 Changeset detected

Latest commit: 0bb1daa

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages
Name Type
@toptal/picasso Major
@toptal/picasso-charts Major
@toptal/picasso-forms Major
@toptal/picasso-rich-text-editor Major
@topkit/analytics-charts Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the contribution DO NOT ADD MANUALLY label Jul 14, 2023
@toptal-devbot
Copy link
Collaborator

Greetings from FX team, @alexvcasillas 👋

Thank you so much for contributing 🙇

We have got high priority ticket generated on our Kanban board so we will do our best to make your experience supreme!

What's next? We will collaborate using this workflow. For you this practically means making sure DONE criteria is met and responding promptly to code review comments 😉

🙏 please, help us improve, rate your contributing experience after merge

@toptal-devbot toptal-devbot temporarily deployed to temploy July 14, 2023 08:16 Inactive
@alexvcasillas alexvcasillas self-assigned this Jul 14, 2023
@alexvcasillas
Copy link
Contributor Author

@toptal-anvil ping reviewers

@alexvcasillas
Copy link
Contributor Author

Note: Until we have the BASE specs for this updated component we should not merge this

@dmaklygin dmaklygin marked this pull request as draft July 14, 2023 12:31
@TomasSlama
Copy link
Contributor

Hey @alexvcasillas any update on this?

@alexvcasillas
Copy link
Contributor Author

Hey @alexvcasillas any update on this?

Yes @TomasSlama , we're going to be working on this in the next sprint :)

@alexvcasillas alexvcasillas marked this pull request as ready for review October 2, 2023 09:40
@alexvcasillas
Copy link
Contributor Author

@toptal-anvil ping reviewers

Copy link
Contributor

@TomasSlama TomasSlama left a comment

Choose a reason for hiding this comment

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

Small comment, that needs to be addressed. I'm also not sure about the actionsAlignment, I want to know opinion about it from my colleagues, I will raise it today on daily, I will let you know

@alexvcasillas
Copy link
Contributor Author

Small comment, that needs to be addressed. I'm also not sure about the actionsAlignment, I want to know opinion about it from my colleagues, I will raise it today on daily, I will let you know

Hey @TomasSlama I've added that property so we can have some room for flexibility because on the early design of this component, the buttons were alignment on the left on the initial state of the dismissable modal and on the right when the modal becomes undismissable :)

@alexvcasillas
Copy link
Contributor Author

@toptal-anvil ping reviewers

Copy link
Contributor

@dmaklygin dmaklygin left a comment

Choose a reason for hiding this comment

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

Left some minor comments

@alexvcasillas alexvcasillas force-pushed the comm-2458-extend-application-update-notification-component branch from 6b707b8 to 5f2858f Compare October 12, 2023 10:42
Copy link
Member

@mkrl mkrl left a comment

Choose a reason for hiding this comment

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

Thanks for addressing all the suggestions!
I have one final thing that I think should be fixed and then we can merge it 💪

Copy link
Member

@mkrl mkrl left a comment

Choose a reason for hiding this comment

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

Nice job 👍

@alexvcasillas alexvcasillas merged commit 53ab6f6 into master Oct 12, 2023
18 checks passed
@alexvcasillas alexvcasillas deleted the comm-2458-extend-application-update-notification-component branch October 12, 2023 15:42
@toptal-build toptal-build mentioned this pull request Oct 12, 2023
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution DO NOT ADD MANUALLY
Projects
None yet
5 participants