-
Notifications
You must be signed in to change notification settings - Fork 9
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
Conversation
f3ac678
to
ace1732
Compare
Reviewer's Guide by SourceryThis pull request adds a new README variant called Class diagram for README_updated_paths.md structureclassDiagram
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."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
ace1732
to
3b13e81
Compare
This variant of the README is intended to be used in components that depend on the new version of auro-library.
3b13e81
to
ab3a252
Compare
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.
Checklist:
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: