We're delighted you're reading this because we need volunteer developers to help this project come to fruition. 👏
This project is not complete and will never be. We're open to your suggestions and comments, no matter if you have an idea for A11yJSON, if you want to share data on platforms like Wheelmap, or if you want to consume it in your own apps (for example, from accessibility.cloud).
Please respect our Code of Conduct.
Even if you don’t have the resources to contribute code, you can help A11yJSON by spreading the word.
Before you make a pull request, please open an issue so we can discuss the contribution you want to make.
These steps guide you through contributing to this project:
- Fork the repo
Clone it and install dependencies
git clone https://github.com/sozialhelden/a11yjson npm install
Make and commit your changes.
- Include tests and documentation.
- Ensure that
npm run buildand
npm run test:prodare still working without errors after your changes.
Prerequisites: Have a local Docker installation.
npm run docs:install # Installs the mkdocs-material Docker image npm run docs:live # Run this while making changes in the docs/ Markdown files npm run docs:deploy # Deploys the documentation on GitHub pages