microsoft / microsoft/AdaptiveCards
Need documentation/tooling in aid of accessibility for card authors
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2k
- Forks
- 595
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 1
Description
We need to make sure we have documentation (blog posts, etc.) and tooling (aclint, etc.) around accessibility considerations. For example, we should surface a warning to authors if they add an image to a card without altText. Similarly, we should describe how various elements project into the accessibility space so that authors can make reasoned choices about how to structure a card (see original problem below).
Do we have (or plan to have) a customer facing document on how to make sure your cards are accessible? This seems like something we should capture in a tips and tricks kind of way to encourage others to avoid this pitfall.
Originally posted by @RebeccaAnne in https://github.com/microsoft/AdaptiveCards/pull/4736#discussion_r485043725
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the original problem in the linked pull request discussion and the existing accessibility documentation and aclint tooling. Done means providing customer-facing guidance for accessible cards and defining tooling coverage, including a warning when an image lacks altText.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, documentation, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100