Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 2.79 KB
Raw

Contributing to ARIA-AT App

We want to make contributing to this project as approachable and transparent as possible. ARIA-AT App is maintained by Bocoup and designed and developed with the W3C ARIA-AT Community Group.

Code of Conduct

This project is governed by the Bocoup and W3C Codes of Conduct.

Development Process

We use GitHub to host code, track issues and feature requests, and accept pull requests.

Issues

We use GitHub issues to track bugs, feature requests, and implementation proposals. Report a bug by opening a new issue.

If your issue relates to a specific ARIA-AT test plan or the behavior of the ARIA-AT test renderer, please open an issue in the aria-at repo.

Pull Requests

Pull requests are the best way to propose changes to the codebase. We use GitHub Flow as a development methodology.

If the pull request is not a bug fix, an implementation proposal should first be submitted via a new issue, in order to reach consensus with the maintainers on scope, technical approach, and design implications.

Implementation proposals and pull requests that affect the overall design or user experience of the app may require a design review before implementation.

Pull requests should be small and granular, ideally addressing one issue or feature at a time. Try to keep each pull request independently mergeable. Multiple dependent PRs should only be used when absolutely necessary to land a longer-term change.

In order to open a pull request:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. If the pull request is not a bug fix, please link to the related implementation proposal and consensus issue.
  6. Submit a pull request!

Maintainers with write access to the repository will create branches directly within the repository.

Reviewing pull requests, merging, and deploying

All pull requests, including pull requests opened by maintainers, require code review from two maintainers before merging.

The second maintainer who reviews is responsible for merging the pull request into the protected main branch.

Maintainers will periodically deploy the main branch to the staging environments.

License

When you submit code changes, your submissions are understood to be under the same W3C Document License that covers the project.