Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 2.09 KB

Contributing

Platform

The Open A11y Test Site is built on a basic LAMP Platform. The backend is run on PHP and MySQL running on Apache on CentOS. The front-end is HTML5 and CSS3.

General Guidelines

Note February 22, 2014: This information is subject to numerous and drastic changes in the near future. For now, email [email protected] to discuss ways to contribute

  • Fork the repo and work against your fork.
  • New submissions must have a related issue. Describe specifically what is needed and why.
  • Issue your pull request against that specific issue.

Contributing to Front-End work

Given the nature of this system, we want the front-end to support the widest range of user agents and assistive technologies as possible. Do not use the latest and greatest bleeding edge feature unless it degrades gracefully. Try to avoid workarounds and polyfills.

Accessibility

  • Naturally, given the nature of this system, all work must be accessible and must conform, without exception, to WCAG 2.0 Level AAA

Design

  • We use SASS (without Compass) for CSS. Always look for an existing declaration or mixin before adding new ones.

JavaScript

  • For the most part, JavaScript use should be extremely limited in this system and reserved for cases where it is needed for performance, cross-platform compatibility, or critical features.
  • Presentation or modification of UI components with JavaScript is especially discouraged in this system.
  • This system uses jQuery 1.10. Feel free to use vanilla JS as well. No other JS frameworks will be used.
  • All non-trivial features must be accompanied by working unit tests.

Contributing to Back-End work

Backend work is driven by PHP & MySQL using the gs_libs PHP library from Karl Groves. The database class in that library is based on PDO. Documentation for gs_libs is available in HTML, latex, rtf, and even man pages.

Bugs and Improvements

  • Find a bug? Create an issue.
  • If you can fix it, please do so.