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

Beta tech debt #256

Merged
merged 3 commits into from
Oct 3, 2024
Merged

Beta tech debt #256

merged 3 commits into from
Oct 3, 2024

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Oct 3, 2024

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: # (issue, if applicable)

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Refactor component registration using RuntimeUtils, update design token references for improved consistency, and update documentation to reflect new stylesheet versions.

Enhancements:

  • Refactor component registration to use RuntimeUtils for registering 'custom-datepicker'.
  • Update design token references to use more consistent and descriptive variable names for box shadow and chevron colors.

Documentation:

  • Update README.md to reflect new versions of design tokens and web core stylesheets.

@jordanjones243 jordanjones243 requested a review from a team as a code owner October 3, 2024 21:15
Copy link

sourcery-ai bot commented Oct 3, 2024

Reviewer's Guide by Sourcery

This pull request focuses on updating the Auro Design System's datepicker component. The changes include refactoring the component registration process, updating design tokens and CSS variables, and adjusting dependencies. These modifications aim to improve the component's consistency with the design system and enhance its maintainability.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Refactored component registration process
  • Removed custom registerComponent function
  • Imported RuntimeUtils from auro-library
  • Used RuntimeUtils to register the component
index.js
Updated design tokens and CSS variables
  • Changed mobile header box shadow color to use elevation token
  • Updated nav button chevron color to use primary icon color
  • Consolidated cell box shadow colors into a single variable
  • Removed unused color variables
demo/api.md
src/tokens.scss
src/color-cell.scss
Updated dependencies in README
  • Updated design-tokens version to 4.10.0
  • Updated webcorestylesheets version to 5.1.2
README.md
Removed version information for related components
  • Removed version information for dropdown component
  • Removed version information for input component
  • Removed version information for popover component
src/dropdownVersion.js
src/inputVersion.js
src/popoverVersion.js

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@jordanjones243 jordanjones243 linked an issue Oct 3, 2024 that may be closed by this pull request
2 tasks
@jordanjones243 jordanjones243 self-assigned this Oct 3, 2024
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @jordanjones243 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Could you provide more information about the removal of version numbers from dropdownVersion.js, inputVersion.js, and popoverVersion.js? How will this affect version tracking and dependency management in the project?
  • The change from a custom registerComponent function to using RuntimeUtils.default.prototype.registerComponent may impact backwards compatibility. Can you explain the reasoning behind this change and confirm that it won't break existing implementations?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@jordanjones243 jordanjones243 merged commit 0e705de into beta Oct 3, 2024
3 of 4 checks passed
@jordanjones243 jordanjones243 deleted the jjones/betaTechDebt branch October 3, 2024 21:16
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.8.0-beta.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

Update color tokens for theming support
2 participants