Contributing to the APG
+ +Introduction
++ Continuous improvement to the utility and quality of the ARIA Authoring Practices Guide (APG) depends on broad community input and participation. + Anyone may contribute feedback, suggestions, or code via the channels described below. + However, if you would like to contribute regularly, please consider + joining the Authoring Practices Task Force. + As a task force participant, you and your organization have greater influence over APG development, and are listed as contributors where appropriate. +
+Providing feedback
++ The APG provides two public feedback channels -- GitHub and email. + Links to both are provided at the bottom of every page in the APG. +
++ GitHub issues are the best way to ask a question, make a suggestion, or report a problem. + Before creating a new issue, it is helpful if you first review existing issues to determine whether there is an issue addressing the same concern. + If so, please comment on that issue rather than raising another. + If the concern you would like addressed is related to an example implementation of an APG pattern, at the bottom of the page, next to the revision date, there is a link named "Related Issues". + That link opens a GitHub project containing all issues associated with the relevant pattern and its examples. +
++ View and create APG issues on GitHub. +
++ The task force also uses the aria-practices public mailing list for email discussion. + Meeting announcements, agendas, and links to minutes are sent to the mailing list. + While GitHub issues are the preferred place to discuss APG content, the mailing list is available to anyone who would prefer to communicate by + sending email to the ARIA Authoring Practices public mailing list. +
+ +Making improvements to documentation or code
++ If you would like to help improve the APG with enhancements or fixes to documentation or code, please adhere to the following procedure. +
+-
+
- Get your development environment ready:
+
-
+
- + Install and configure linters as described in the + code conformance section of the repository readme. + +
- + Read our wiki page about + preparing and submitting pull requests. + +
+ - Comment in an existing issue or raise a new issue, expressing your willingness to help and briefly summarizing the nature of your proposed resolution. +
- An editor will confirm there are no conflicting plans and, if needed, provide guidance. +
- Do some fabulous work and submit a pull request. +
- Watch your GitHub notifications and respond to feedback during the pull request review process. +
+ If you run into any difficulties, please feel free to ask questions either via a GitHub issue or by + sending email to the ARIA Authoring Practices public mailing list. +
+Helping provide assistive technology support data
++ The assistive technology support tables included on APG example pages, e.g., + Assistive Technology Support for Radio Group Example Using aria-activedescendant, + are provided by the + ARIA and Assistive Technologies (ARIA-AT) Community Group. + The ARIA-AT community group aims to ensure APG patterns have consistent and interoperable accessibility support. + If you would like to contribute to this aspect of the APG, you can learn more about the ARIA-AT project and how to contribute at + ARIA and Assistive Technologies Home. +
+
