Skip to content

Commit

Permalink
Remove accessibility from CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Moved to README.md
  • Loading branch information
staceybeard authored Nov 25, 2019
1 parent e20b1cf commit ea57d95
Showing 1 changed file with 0 additions and 31 deletions.
31 changes: 0 additions & 31 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,34 +50,6 @@ Any changes to the code base should follow the style and coding conventions
used in the rest of the project. The version history should be clean, and
commit messages should be descriptive and [properly formatted][commit-messages].

Testing
-------

### Accessibility
Testing for accessibility is a great way to make sure that all hackathon
enthusiasts can use Quill, regardless of ability. It's good practice to run
accessibility tests on any changes that you've made to ensure that no new
accessibility errors were introduced.

An accessibility testing tool, pa11y-ci, has been provided and configured for
this project. To run pa11y-ci, make sure that Quill is running locally on
http://localhost:3000/ (alternatively, you can change the URLs specified in
`.pa11yci` to match those of your running instance). Then, run the command
`npm run test:accessibility`. If several of the URLs checked by pa11y-ci
produce the same number of errors, pa11y-ci may be having trouble logging in
with the default admin credentials specified in `.env`. Check that your
instance of Quill is running correctly, or change the credentials used in
`.pa11yci`.

If your contribution adds any new pages to Quill, please add them to
`.pa11yci` to make sure that these pages are covered by the accessibility
tests. If your new pages are accessed as a non-logged-in user, add them at the
beginning of the URL list. If they are accessed when logged in, add them after
the URL with actions to log in.

For more information on pa11y-ci, please visit [pa11y-ci] and [pa11y],
in particular the [section on actions][pa11y-actions].

---

If you have any questions about anything, feel free to [ask][email]!
Expand All @@ -90,6 +62,3 @@ If you have any questions about anything, feel free to [ask][email]!
[email]: mailto:quill@hackmit.org
[commit-messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[gavel]: https://github.com/anishathalye/gavel
[pa11y-ci]: https://github.com/pa11y/pa11y-ci
[pa11y]: https://github.com/pa11y/pa11y
[pa11y-actions]: https://github.com/pa11y/pa11y#actions

0 comments on commit ea57d95

Please sign in to comment.