-
Notifications
You must be signed in to change notification settings - Fork 1
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
Address tech debt #86
Conversation
Reviewer's Guide by SourceryThis pull request addresses technical debt by refactoring component registration, updating dependencies, and improving code organization. The changes focus on using the Auro Design System's library scripts, modernizing the codebase, and enhancing maintainability. File-Level Changes
Tips
|
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 @jordanjones243 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider keeping the CSS custom property fallbacks section in the README, as it provides valuable information for developers working with older browsers.
- Ensure that the new eslint configuration properly handles the cases where eslint-disable comments were removed, particularly in the auro-table.js file.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 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 to tell me if it was helpful.
@@ -34,6 +40,11 @@ export class AuroTable extends LitElement { | |||
]; | |||
} | |||
|
|||
firstUpdated() { |
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.
suggestion: Add comment explaining the purpose of firstUpdated method
Consider adding a brief comment explaining why handling component tag rename is necessary in this lifecycle method.
/**
* Lifecycle method called after the component's first update.
* Handles component tag rename for backwards compatibility.
*/
firstUpdated() {
recommendedConfig: js.configs.recommended, | ||
allConfig: js.configs.all | ||
}); | ||
export default [...compat.extends("@aurodesignsystem/eslint-config")]; |
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.
suggestion: Add comments explaining the purpose of this configuration
Consider adding some comments to explain the purpose and structure of this ESLint configuration for future maintainers.
// ESLint configuration extending Auro Design System's config
export default [
...compat.extends("@aurodesignsystem/eslint-config")
];
🎉 This PR is included in version 2.2.0-beta.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
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
Refactor component registration to utilize auro-library scripts, introduce a new feature for custom component tag attributes, update ESLint configuration, and refresh documentation to align with these changes.
New Features:
Enhancements:
Build:
Documentation: