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

Add HTML AAM considerations to PR template and enable for HTML #76

Merged
merged 4 commits into from
Dec 6, 2024

Conversation

annevk
Copy link
Member

@annevk annevk commented Dec 4, 2024

@domenic @scottaohara let me know if you have any thoughts. The main thing this adds to the PR template for HTML will look like this:

and I would expect it to be completed like this:

  • Corresponding HTML AAM issue or PR: N/A

or:

  • Corresponding HTML AAM issue or PR: PR link

(This has been edited to instead feature the latest suggestion.)

@aphillips
Copy link

aphillips commented Dec 4, 2024

What about other horizontal concerns, e.g. security, privacy, sustainability, and the like?

Why would separate PRs be created for a11y/i18n? Shouldn't these types of issues be addressed in PR being created with the template?

I might prefer to just see the i18n-tracker label on PRs that have I18N-related gorp in them. If the checkbox is just a reminder that we think I18N is important, perhaps instead:

  • Horizontal issues (A11Y, I18N, etc.) have been addressed

Or am I not understanding?

(PS> Consider adding i18n-tracker label to this PR so that it's tracked in our repo)

@annevk
Copy link
Member Author

annevk commented Dec 4, 2024

Hmm yeah.

Maybe I should restrict this to accessibility and in particular HTML AAM which "frequently" ends up needing changes due to changes in HTML semantics.

Most other horizontal concerns don't really have that kind of integration.

@annevk annevk changed the title Add optional a11y/i18n considerations to PR template and enable for HTML Add HTML AAM considerations to PR template and enable for HTML Dec 5, 2024
@annevk annevk requested a review from domenic December 5, 2024 06:55
@scottaohara
Copy link

thanks for this @annevk

i think this would be a good add. arguably a second check for aria in html issue/pr might be helpful? but, maybe just html aam is enough since that'll get it on the ARIA wg's radar and then we can determine if an aria in html issue/pr would be necessary or not.

annevk added a commit to whatwg/html that referenced this pull request Dec 6, 2024
@annevk annevk merged commit cd2101d into main Dec 6, 2024
@annevk annevk deleted the a11yi18n branch December 6, 2024 07:48
annevk added a commit to whatwg/html that referenced this pull request Dec 6, 2024
elif variable == "a11y-check":
output = ""
if data:
output = "\n- [ ] Corresponding [HTML AAM](https://w3c.github.io/html-aam/) & [WAI-ARIA](https://w3c.github.io/aria/) issues & PRs:"
Copy link
Member

Choose a reason for hiding this comment

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

@scottaohara asked to add "ARIA in HTML" which is https://w3c.github.io/html-aria/ . I think ARIA usually don't need changes for changes in HTML.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sigh. Okay. Will create some more PRs.

Copy link
Member Author

Choose a reason for hiding this comment

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

#77
whatwg/html#10830

And thanks for catching!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

5 participants