Skip to content

Commit 7fb7c8e

Browse files
mcking65jongunddaniel-montalvoa11ydoer
authored
About Section: Add a page about contributing and APG TF membership (pull #2734)
Resolves #2706 by adding a new page providing instructions for contributing to the APG. It describes each of the contribution channels and describes how to utilize each of them. --------- Co-authored-by: Jon Gunderson <[email protected]> Co-authored-by: Daniel Montalvo <[email protected]> Co-authored-by: JaEun Jemma Ku <[email protected]>
1 parent f97050b commit 7fb7c8e

File tree

2 files changed

+139
-0
lines changed

2 files changed

+139
-0
lines changed

‎content/about/about.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,13 @@ <h2><a href="aria-basics/aria-basics.html">ARIA Basics</a></h2>
3030
<a href="aria-basics/aria-basics.html">ARIA Basics</a>.
3131
</p>
3232
</li>
33+
<li>
34+
<h2><a href="contributing/contributing.html">Contributing to the APG</a></h2>
35+
<p>
36+
The APG Task Force relies on broad community representation and participation to continuously improve the usefulness and quality of the APG.
37+
<a href="contributing/contributing.html">Learn how you can contribute and help promote development of accessible experiences</a>.
38+
</p>
39+
</li>
3340
<li>
3441
<h2><a href="acknowledgements/acknowledgements.html">Acknowledgements</a></h2>
3542
<p>

‎content/about/contributing/contributing.html

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
4+
<head>
5+
<meta charset="UTF-8">
6+
<meta content="width=device-width, initial-scale=1.0" name="viewport">
7+
<title>Contributing to the APG</title>
8+
9+
<!-- Core JS and CSS shared by all About content -->
10+
<link rel="stylesheet" href="https://www.w3.org/StyleSheets/TR/2016/base.css">
11+
<link rel="stylesheet" href="../../shared/css/core.css">
12+
<script src="../../shared/js/highlight.pack.js"></script>
13+
<script src="../../shared/js/app.js"></script>
14+
<script src="../../shared/js/skipto.js"></script>
15+
</head>
16+
17+
<body>
18+
<main>
19+
<h1>Contributing to the APG</h1>
20+
21+
<section id="introduction">
22+
<h2>Introduction </h2>
23+
<p>
24+
Continuous improvement to the utility and quality of the ARIA Authoring Practices Guide (APG) depends on broad community input and participation.
25+
Anyone may contribute feedback, suggestions, or code via the channels described below.
26+
However, if you would like to contribute regularly, please consider
27+
<a href="#joining-the-authoring-practices-task-force">joining the Authoring Practices Task Force</a>.
28+
As a task force participant, you and your organization have greater influence over APG development, and are listed as contributors where appropriate.
29+
</p>
30+
</section>
31+
32+
<section id="providing-feedback">
33+
<h2>Providing feedback</h2>
34+
<p>
35+
The APG provides two public feedback channels -- GitHub and email.
36+
Links to both are provided at the bottom of every page in the APG.
37+
</p>
38+
<p>
39+
GitHub issues are the best way to ask a question, make a suggestion, or report a problem.
40+
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.
41+
If so, please comment on that issue rather than raising another.
42+
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".
43+
That link opens a GitHub project containing all issues associated with the relevant pattern and its examples.
44+
</p>
45+
<p>
46+
<a href="https://github.com/w3c/aria-practices/issues">View and create APG issues on GitHub.</a>
47+
</p>
48+
<p>
49+
The task force also uses the aria-practices public mailing list for email discussion.
50+
Meeting announcements, agendas, and links to minutes are sent to the mailing list.
51+
While GitHub issues are the preferred place to discuss APG content, the mailing list is available to anyone who would prefer to communicate by
52+
<a href="mailto:[email protected]">sending email to the ARIA Authoring Practices public mailing list</a>.
53+
</p>
54+
<p>
55+
<a href="https://lists.w3.org/Archives/Public/public-aria-practices/">View the aria-practices mailing list archive</a>.
56+
</p>
57+
</section>
58+
59+
<section id="Making-improvements-to-documentation-or-code">
60+
<h2>Making improvements to documentation or code</h2>
61+
<p>
62+
If you would like to help improve the APG with enhancements or fixes to documentation or code, please adhere to the following procedure.
63+
</p>
64+
<ol>
65+
<li>Get your development environment ready:
66+
<ul>
67+
<li>
68+
Install and configure linters as described in the
69+
<a href="https://github.com/w3c/aria-practices#code-conformance">code conformance section of the repository readme</a>.
70+
</li>
71+
<li>
72+
Read our wiki page about
73+
<a href="https://github.com/w3c/aria-practices/wiki/Submitting-Pull-Requests">preparing and submitting pull requests</a>.
74+
</li>
75+
</ul>
76+
</li>
77+
<li>Comment in an existing issue or raise a new issue, expressing your willingness to help and briefly summarizing the nature of your proposed resolution.</li>
78+
<li>An editor will confirm there are no conflicting plans and, if needed, provide guidance.</li>
79+
<li>Do some fabulous work and submit a pull request.</li>
80+
<li>Watch your GitHub notifications and respond to feedback during the pull request review process.</li>
81+
</ol>
82+
<p>
83+
If you run into any difficulties, please feel free to ask questions either via a GitHub issue or by
84+
<a href="mailto:[email protected]">sending email to the ARIA Authoring Practices public mailing list</a>.
85+
</p>
86+
</section>
87+
88+
<section id="joining-the-authoring-practices-task-force">
89+
<h2>Joining The Authoring Practices Task Force</h2>
90+
<p>
91+
The APG is developed by the
92+
<a target="_blank" href="https://www.w3.org/WAI/ARIA/task-forces/practices/">ARIA Authoring Practices Task Force</a>,
93+
which is a sub-group of the
94+
<a target="_blank" href="https://www.w3.org/WAI/ARIA/">ARIA Working Group</a>.
95+
The task force meets weekly to coordinate work on development of the APG.
96+
Task force participants are expected to regularly attend meetings and to actively contribute.
97+
Examples of contributions include:
98+
</p>
99+
<ul>
100+
<li>Testing the functionality and accessibility of example implementations of the APG patterns</li>
101+
<li>Fixing bugs and implementing enhancements in example implementations of the APG patterns</li>
102+
<li>Helping write responses to community feedback</li>
103+
<li>Reviewing and editing documentation</li>
104+
<li>Designing or engineering pattern implementation examples</li>
105+
<li>Creating and editing patterns and practices for ARIA usage</li>
106+
</ul>
107+
<p>
108+
To participate in the Authoring Practices Task Force, you first need to
109+
<a href="https://www.w3.org/WAI/ARIA/participation">become a participant in the ARIA Working Group</a>.
110+
If you are already a participant in the ARIA Working Group, contact
111+
<a href="https://www.w3.org/staff/#dmontalvo">Daniel Montalvo</a>
112+
and request membership in the Authoring Practices Task Force.
113+
</p>
114+
</section>
115+
116+
<section id="Helping-provide-assistive-technology-support-data">
117+
<h2>Helping provide assistive technology support data</h2>
118+
<p>
119+
The assistive technology support tables included on APG example pages, e.g.,
120+
<a href="../../patterns/radio/examples/radio-activedescendant.html#at-support">Assistive Technology Support for Radio Group Example Using aria-activedescendant</a>,
121+
are provided by the
122+
<a href="https://www.w3.org/groups/cg/aria-at/">ARIA and Assistive Technologies (ARIA-AT) Community Group</a>.
123+
The ARIA-AT community group aims to ensure APG patterns have consistent and interoperable accessibility support.
124+
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
125+
<a href="https://aria-at.w3.org/">ARIA and Assistive Technologies Home</a>.
126+
</p>
127+
</section>
128+
129+
</main>
130+
</body>
131+
132+
</html>

0 commit comments

Comments
 (0)