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.

Sign up for GitHub

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

Jump to bottom

Hero a11y Updates #336

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Hero a11y Updates #336

wants to merge 6 commits into from

Conversation

JoshBowdenConcepts
Copy link
Contributor

@JoshBowdenConcepts JoshBowdenConcepts commented Jul 11, 2023 •
edited

Summary

A collection of changes requested from the a11y sign off review.

List of notable changes:

  • removed aria-labeledby and id from the Hero component header because it was unnecessary
  • removed br from the heading in the codespace story because it is inacessible

What should reviewers focus on?

  • Making sure the Stories function correctly and reflect the requested changes in the a11y sign-off issue

Steps to test:

  1. Open the Hero component in CI-deployed preview environment
  2. Go to all stories in Storybook and on primer.style
  3. Verify that each story behaves as expected

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • New visual snapshots have been generated / updated for any UI changes
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Links:

@changeset-bot
Copy link

changeset-bot bot commented Jul 11, 2023 •
edited

🦋 Changeset detected

Latest commit: 8c9d649

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@primer/react-brand Patch
@primer/brand-primitives Patch
@primer/brand-e2e Patch
@primer/brand-fonts Patch
@primer/brand-config Patch
@primer/brand-storybook Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jul 11, 2023 •
edited

🟢 No design token changes found

@JoshBowdenConcepts JoshBowdenConcepts temporarily deployed to github-pages July 11, 2023 18:15 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Jul 11, 2023 •
edited

⚠️ Visual differences found

Our visual comparison tests found UI differences.

Please review the differences by using the test artifacts to ensure that the changes were intentional.

Artifacts can be downloaded and reviewed locally.

Download links are available at the bottom of the workflow summary screen.

Example:

artifacts section of workflow run

If the changes are expected, please run npm run test:visual:update-snapshots to replace the previous fixtures.

Review visual differences

@JoshBowdenConcepts JoshBowdenConcepts temporarily deployed to github-pages July 11, 2023 18:25 — with GitHub Actions Inactive
@JoshBowdenConcepts JoshBowdenConcepts marked this pull request as ready for review July 12, 2023 13:40
rezrah
rezrah reviewed Jul 17, 2023
View reviewed changes
.changeset/silent-trainers-guess.md Outdated

- Removed unnecessary `aria-labeledby` on the section component
- Removed the related `id` on the heading component
- Removed `br` from Hero feature story which is inaccessible
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one can be removed, as it doesn't affect package output

Suggested change
- Removed `br` from Hero feature story which is inaccessible

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in SHA

rezrah
rezrah reviewed Jul 17, 2023
View reviewed changes
.changeset/silent-trainers-guess.md Outdated
- Removed unnecessary `aria-labeledby` on the section component
- Removed the related `id` on the heading component
- Removed `br` from Hero feature story which is inaccessible
- Updated `button` text in hero story to be more descriptive
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same with this one, as it doesn't affect package output

Suggested change
- Updated `button` text in hero story to be more descriptive

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in SHA

@JoshBowdenConcepts JoshBowdenConcepts temporarily deployed to github-pages July 17, 2023 15:42 — with GitHub Actions Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rezrah rezrah rezrah left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
update snapshots
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@JoshBowdenConcepts @rezrah