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

Add missing tier 3 token section #41

Merged
merged 3 commits into from
Oct 8, 2024

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Oct 7, 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: #40

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

Revise the SCSS variable naming for background color to improve clarity and update documentation to include a missing code snippet for the new token.

Enhancements:

  • Update the SCSS variable from '--ds-auro-container-color' to '--ds-auro-background-container-color' for better clarity and consistency.

Documentation:

  • Add a missing code snippet section in 'demo/api.md' to demonstrate the usage of the '--ds-auro-background-container-color' token.

Copy link

sourcery-ai bot commented Oct 7, 2024

Reviewer's Guide by Sourcery

This pull request adds a missing tier 3 token section to the auro-background component. It updates the documentation, adjusts the component's default background color variable, and includes the necessary SCSS code snippet.

Updated class diagram for AuroBackground component

classDiagram
    class AuroBackground {
        +String bg
        +String bgSm
        +String bgMd
        +String bgLg
        +render()
    }

    AuroBackground : --background = this.bg || 'var(--ds-auro-background-container-color)'
    AuroBackground : --backgroundSm = this.bgSm || 'var(--background)'
    AuroBackground : --backgroundMd = this.bgMd || 'var(--backgroundSm)'
    AuroBackground : --backgroundLg = this.bgLg || 'var(--backgroundMd)'
Loading

File-Level Changes

Change Details Files
Update default background color variable
  • Change '--ds-auro-container-color' to '--ds-auro-background-container-color'
  • Update the render function to use the new variable name
src/auro-background.js
src/tokens.scss
Add missing SCSS code snippet to documentation
  • Include SCSS code block with import statement and host selector
  • Define '--ds-auro-background-container-color' variable
demo/api.md
Update documentation files
  • Remove placeholder comment in docs/partials/api.md
  • Add AURO-GENERATED-CONTENT end tag in docs/partials/api.md
docs/partials/api.md

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

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 self-assigned this Oct 7, 2024
@jordanjones243 jordanjones243 requested a review from a team October 7, 2024 17:52
@jordanjones243 jordanjones243 linked an issue Oct 7, 2024 that may be closed by this pull request
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:

  • In docs/partials/api.md, was the removal of the code snippet intentional? If not, consider adding the updated SCSS code snippet there as well for consistency.
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.

@jason-capsule42 jason-capsule42 merged commit 6e00820 into main Oct 8, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the jjones/backgroundTokens/#40 branch October 8, 2024 15:44
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Token theming color section not displaying
3 participants