-
Notifications
You must be signed in to change notification settings - Fork 0
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
SDCSRM-375 Updated design system version #36
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #36 +/- ##
=======================================
Coverage 97.32% 97.32%
=======================================
Files 9 9
Lines 187 187
=======================================
Hits 182 182
Misses 5 5 ☔ View full report in Codecov by Sentry. |
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.
Upon reviewing the pull request titled "SDCSRM-375 Updated design system version #36," it is evident that the primary focus was on updating the design system version and addressing specific issues identified in a recent DAC report. The changes include updating the design system version to 70.0.2, code adjustments related to the new design system, and a fix for a usability issue around error message links. Below is a clear and concise expert review:
Review Summary:
- Design System Update:
The load_templates.sh script has been updated to reflect the new design system version (from 65.1.0 to 70.0.2). This is a straightforward version bump which is in line with the ticket's objective. - Code Changes:
Changes in cookies.html, messages.html, and start.html templates show modifications corresponding to the design system update, such as replacing type with variant.
Ensure these changes match the new design system's documentation and that the naming conventions are consistent. - Usability Fix:
The usability issue concerning the error message link seems to be addressed with the inclusion of updated classes and variants for links and error panels.
It is essential to manually verify this fix to ensure it indeed resolves the issue as intended and does not introduce any new issues. - Testing:
The instructions to run tests and build the image have been provided, indicating automated tests are expected to pass.
The description also suggests conducting acceptance tests (ATs) against the srm-rh-ui. It is important to confirm that these have been carried out and have passed successfully. - Code Coverage:
The Codecov report indicates that the project's coverage is at 97.32%, which is exceptionally high and suggests that the changes are well-tested. - Documentation:
Ensure that any new conventions or patterns introduced with the design system update are documented for future reference.
The PR should ideally include notes about any significant changes or migration steps required due to the design system update.
Conclusion:
Based on the presented changes, the PR seems to address the intended issues without introducing any apparent regressions. It aligns with the motivations outlined and follows the project's established practices. Assuming that all tests pass and no additional issues have been reported by other reviewers, this PR can be approved.
However, it is critical to ensure that the SVG image role and other accessibility issues raised but not yet fixed in the design system are documented and communicated with the design system team for future resolution.
Motivation and Context
After a recent DAC report on rh-ui, we wanted to update the design system version to see if the updates have fixed some of the issues it's found. The main issues were:
Looks like the Button context has been fixed in the design system but the SVG image role issue hasn't been yet for the ones we use (I can see the design system and fixed similar issues). I'll need to raise these with the design system so they can look at fixing them.
The report included some usability feedback so I had a look to see what I could fix. There was one issue around the error message link not putting you back into the box which I've fixed.
What has changed
How to test?
Links
DAC accessability report
Jira
Trello