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 _updated_paths README variant #584

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

DukeFerdinand
Copy link
Contributor

@DukeFerdinand DukeFerdinand commented Oct 16, 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: #582

Summary:

Adds the updated README variant including handlebars variables in place of legacy bracket variables ([name]) and updates the partial content paths to reflect being consumed from a repository root.

Type of change:

Please delete options that are not relevant.

  • Revision of an existing capability

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

Documentation:

  • Introduce a new README variant with updated paths and handlebars variables.

@DukeFerdinand DukeFerdinand force-pushed the dhook/add-alternative-README branch from f3ac678 to ace1732 Compare October 16, 2024 22:44
@DukeFerdinand DukeFerdinand self-assigned this Oct 16, 2024
@DukeFerdinand DukeFerdinand marked this pull request as ready for review October 16, 2024 22:48
@DukeFerdinand DukeFerdinand requested a review from a team as a code owner October 16, 2024 22:48
Copy link

sourcery-ai bot commented Oct 16, 2024

Reviewer's Guide by Sourcery

This pull request adds a new README variant called README_updated_paths.md to the componentDocs directory. The new file includes updated content with handlebars variables replacing legacy bracket variables and updated partial content paths for consumption from a repository root.

Class diagram for README_updated_paths.md structure

classDiagram
    class README_updated_paths {
        +String capitalize_name
        +String withAuroNamespace_name
        +String description
        +String useCases
        +String readmeAddlInfo
        +String basicExample
        +String browserSupport
        +String componentInstall_esm
        +String designTokens
        +String componentImportDescription
        +String componentImport
        +String bundleInstallDescription
        +String bundleUseModBrowsers
        +String developmentDescription
        +String localhost
        +String api
        +String testing
        +String bundles
    }
    note for README_updated_paths "This class represents the structure of the new README variant with updated paths and handlebars variables."
Loading

File-Level Changes

Change Details Files
Added a new README variant with updated content and variable syntax
  • Introduced handlebars variables (e.g., {{ capitalize name }}) to replace legacy bracket variables ([name])
  • Updated partial content paths to reflect consumption from a repository root
  • Included instructions for editing specific sections of the README
  • Added placeholders for auto-generated content using AURO-GENERATED-CONTENT tags
  • Incorporated remote content fetching from the WC-Generator repository
componentDocs/README_updated_paths.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

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 @DukeFerdinand - I've reviewed your changes and they look great!

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.

@DukeFerdinand DukeFerdinand force-pushed the dhook/add-alternative-README branch from ace1732 to 3b13e81 Compare October 16, 2024 22:50
This variant of the README is intended to be used in components that
depend on the new version of auro-library.
@DukeFerdinand DukeFerdinand force-pushed the dhook/add-alternative-README branch from 3b13e81 to ab3a252 Compare October 16, 2024 22:53
@DukeFerdinand DukeFerdinand added the Type: Documentation Documentation only changes label Oct 16, 2024
@DukeFerdinand DukeFerdinand merged commit c6767a5 into master Oct 21, 2024
6 checks passed
@DukeFerdinand DukeFerdinand deleted the dhook/add-alternative-README branch October 21, 2024 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Documentation only changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[auro-library integration] Remote README template needs updated relative pathing
2 participants