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

Commit attribution descriptive links #16274

Merged
merged 6 commits into from
Mar 14, 2023

Conversation

tidy-dev
Copy link
Contributor

@tidy-dev tidy-dev commented Mar 8, 2023

Closes https://github.com/github/accessibility-audits/issues/3270, https://github.com/github/accessibility-audits/issues/3264

Description

This updates all our "Learn more" links to be more descriptive for screen reader users.

Screenshots

CleanShot 2023-03-08 at 14 21 24
CleanShot 2023-03-08 at 14 20 44
CleanShot 2023-03-08 at 14 28 20
CleanShot 2023-03-08 at 14 23 44
CleanShot 2023-03-08 at 14 22 26

Release notes

Notes: [Improved] Learn more links are descriptive for screen readers.

Copy link
Member

@sergiou87 sergiou87 left a comment

Choose a reason for hiding this comment

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

Could this be the kind of thing where we leave the Learn more text for visual users and use the aria-label or aria-description for non-visual users? It feels like they now look super verbose and redundant in the GUI.

@tidy-dev
Copy link
Contributor Author

tidy-dev commented Mar 10, 2023

The general guidance is to go for more descriptive first. Imho, that is generally just good practice for usability, but also accessibility. However, if size constraints are of concern then using aria-label is an acceptable alternative.

In these cases, I can see in the Misattributed warnings since we are trying to make them be less obtrusive to use them there. But in the repository settings, we already had the full sentence on one of them, all I did was extend the link tags. Thus, feel like keeping them where we have larger real estate makes sense.

Another alternative for the misattributed commits warning was to do like:

This email doesn't match your GitHub Account, so your commits will be <link>wrongly attributed</link>.

^ only concern there was that the "learn more" make it clear that you are likely going to some documentation.

Thoughts?

Copy link
Member

@sergiou87 sergiou87 left a comment

Choose a reason for hiding this comment

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

I prefer using the Learn more verbiage, and the last changes you made look good to me!! :shipit:

@tidy-dev tidy-dev enabled auto-merge March 14, 2023 11:32
@tidy-dev tidy-dev merged commit abb0855 into development Mar 14, 2023
@tidy-dev tidy-dev deleted the commit-attribution-descriptive-links branch March 14, 2023 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants