diff --git a/README.md b/README.md index 617b6441bf..2a361664f4 100644 --- a/README.md +++ b/README.md @@ -3,35 +3,34 @@ # WAI-ARIA: Authoring Practices Guide This repository maintains the WAI-ARIA Authoring Practices Guide. -This is developed by the [ARIA Working Group](http://www.w3.org/WAI/ARIA/). -The staff contact is [Michael Cooper](http://www.w3.org/People/cooper/). -Please do not provide commit access to this repository without coordination. -## Contributing to this Repository +* [Latest editor's draft built from master branch](http://w3c.github.io/aria-practices/) +* [Most recent version published on w3.org](https://www.w3.org/TR/wai-aria-practices-1.1/) +* Developed by the [Authoring Practices Task Force](https://www.w3.org/WAI/ARIA/task-forces/practices/) of the [ARIA Working Group](http://www.w3.org/WAI/ARIA/). +* Staff contact: [Michael Cooper](http://www.w3.org/People/cooper/). -### Code conformance +Please do not provide commit access to this repository without coordination. -* All HTML should validate in the NU HTML Validator. -Exceptions to this rule are warnings and errors related to -future ARIA features we need to implement. -* To keep code in this repository consistent; editors should use a text editor -that supports [EditorConfig](http://editorconfig.org/). +## How the work is organized -### Writing code examples +* Work is planned and prioritized in our [milestones](https://github.com/w3c/aria-practices/milestones?direction=asc&sort=due_date&state=open). Each milestone corresponds to a working draft or release published to w3.org. +* Work is organized by topic in our [projects](https://github.com/w3c/aria-practices/projects). Each project corresponds to a type of design pattern or section of guidance. +* The [scope of work and roadmap](https://github.com/w3c/aria-practices/wiki/Scope) are described in the project wiki. -- Choose a pattern from the - [Design Patterns Development Status](https://github.com/w3c/aria-practices/wiki/Design-Patterns-Development-Status) - document that is missing a code example. -- Via the command line, run: +## Contributing +1. Comment in an existing issue or raise a new issue, expressing your willingness to help and briefly summarizing the nature of your proposed resolution. +2. An editor will confirm there are no conflicting plans and, if needed, provide guidance. +3. Be sure you have ESLint configured as described below. +4. Read our wiki page about [submitting pull requests](https://github.com/w3c/aria-practices/wiki/Submitting-Pull-Requests). +5. Do some fabulous work and submit a pull request. - $ bin/generate +Note: Please feel free to ask questions either through an issue or on the [Authoring Practices Task Force mailing list](http://lists.w3.org/Archives/Public/public-aria-practices/). - Where `` is the dasherized name of the design pattern example. This - creates a new example directory and file with the same name, based on a - template. +### Code conformance -- Edit the new html file with an example corresponding to the description in - `aria-practices.html` +* All HTML should validate in the NU HTML Validator. Exceptions to this rule are warnings and errors related to future ARIA features that are not yet implemented. +* To keep code in this repository consistent; editors should use a text editor that supports [EditorConfig](http://editorconfig.org/). +* All code should test clean with ESLint. ### Running ESLint, the pluggable linting utility for JavaScript and JSX @@ -41,8 +40,7 @@ Pull requests with ESLint errors will not be merged. ### Setup ESLint so you can run it locally -1. If you do not already have node.js installed, - go to the [node installer](https://nodejs.org/en/download/) +1. If you do not already have node.js installed, go to the [node installer](https://nodejs.org/en/download/) 1. When you install Node, NPM is included. 1. In a terminal window from the directory that contains the `aria-practices` repository, run `npm install`. @@ -50,10 +48,8 @@ A successful install will display a tree of installed packages. ### Test and fix your code -1. Open a terminal window to the directory that contains the `aria-practices` -repository -1. The repository has a script defined that will test all JavaScript in the examples -directory. To run it, execute the command `npm test`. +1. Open a terminal window to the directory that contains the `aria-practices` repository +1. The repository has a script defined that will test all JavaScript in the examples directory. To run it, execute the command `npm test`. 1. Many errors can be fixed automatically with the command `npm run fix`. 1. After running fix, test again to see what you need to fix manually. @@ -75,8 +71,7 @@ offending character is indicated by the number `8` after the colon. Change the variable `value_nodes` to `valueNodes` in your source file to eliminate this error. -To see the complete list of style rules that are applied by ESLint, -Check out the [.eslint.json](https://github.com/w3c/aria-practices/blob/master/.eslint.json) file in the root of the project. +To see the complete list of style rules that are applied by ESLint, review the [.eslint.json](https://github.com/w3c/aria-practices/blob/master/.eslint.json) file in the root of the project. ### Editorial documentation