How to Contribute to the WAI-ARIA Authoring Practices Guide

Mar 11, 2022 | Programming

The WAI-ARIA Authoring Practices Guide (APG) serves as a beacon of accessibility and best practices in web development. Developed by the Authoring Practices Task Force of the ARIA Working Group, it provides valuable guidance for creating more accessible web interfaces. If you’re eager to contribute to this important resource, you’re in the right place! Follow this guide to navigate your way through the contribution process smoothly.

Understanding the Structure of the APG

The WAI-ARIA Authoring Practices Guide is well-structured, making it easier for contributors to understand how they can add value. Here’s how the work is organized:

  • Milestones: Work is planned and prioritized in milestones that correspond to working drafts or releases published at w3.org/wai/aria/apg.
  • Projects: The work is categorized by topics which correlate to design patterns or sections of guidance. You can view these projects at GitHub Projects.
  • Scope & Roadmap: A detailed description of the project’s scope and how it plans to proceed can be found in the project wiki here.

Steps to Contribute

Ready to dive in? Follow these steps to make your contribution:

  1. Engage: Comment on an existing issue or raise a new one detailing your willingness to contribute and a brief overview of your proposed resolution.
  2. Get Confirmation: An editor will confirm that there are no conflicting plans and may provide further guidance.
  3. Set Up Your Tools: Make sure you have linters installed and configured as described in the project documentation.
  4. Read About Pull Requests: Familiarize yourself with the process of submitting pull requests by checking out the [Submitting Pull Requests](https://github.com/w3c/aria-practices/wiki/Submitting-Pull-Requests) page.
  5. Do Great Work: Implement your solution and submit a pull request.

Checking Code Quality

This repository prides itself on quality, and to maintain this, it employs linting tools for static code analysis. The tools ensure that your HTML, CSS, and JavaScript meet rigorous standards. Here’s how you can ensure your code conforms:

1. Install Node.js and npm.
2. Open your terminal in the aria-practices repository directory.
3. Run npm install to set up the environment.
4. Test your code using npm run lint:html, npm run lint:css, and npm run lint:js.

Running Tests and Fixes

Testing your code involves running predefined scripts. Here’s how:

  1. Open a terminal window in your aria-practices repository directory.
  2. Execute the command npm test to run tests on all JavaScript in the examples directory.
  3. Fix errors automatically by running npm run fix, and re-test the code afterward.

Errors reported by the linter will specify details like the file name and line number, helping you pinpoint required fixes. For example, if a variable name does not comply with the camelCase convention, simply rename it accordingly.

Troubleshooting Tips

If you run into issues while contributing, here are some troubleshooting ideas:

  • Ensure all linters and necessary tools are fully installed and configured. Refer to the documentation if needed.
  • Check the project’s Code Guide for detailed information on expected code standards.
  • If you’re facing specific errors, consider checking the project’s issues section or ask questions on the Authoring Practices Task Force mailing list available here.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Additional Resources

For editorial guidance, refer to the APG Editorial Style Guidelines which can help you in writing quality prose for the guide.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Stay Informed with the Newest F(x) Insights and Blogs

Tech News and Blog Highlights, Straight to Your Inbox