mirror of
https://github.com/pa11y/pa11y-dashboard.git
synced 2025-09-24 14:21:13 +00:00
Add a contributing guide (#163)
This commit is contained in:
21
CONTRIBUTING.md
Normal file
21
CONTRIBUTING.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
|
||||||
|
Contributing Guide
|
||||||
|
==================
|
||||||
|
|
||||||
|
Thanks for getting involved :tada:
|
||||||
|
|
||||||
|
The Pa11y team loves to see new contributors, and we strive to provide a welcoming and inclusive environment. We ask that all contributors read and follow [our code of conduct][code-of-conduct] before joining. If you represent an organisation, then you might find our [guide for companies][companies] helpful.
|
||||||
|
|
||||||
|
Our website outlines the many ways that you can contribute to Pa11y:
|
||||||
|
|
||||||
|
- [Help us to talk to our users][communications]
|
||||||
|
- [Help us out with design][designers]
|
||||||
|
- [Help us with our code][developers]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[code-of-conduct]: http://pa11y.org/contributing/code-of-conduct/
|
||||||
|
[communications]: http://pa11y.org/contributing/communications/
|
||||||
|
[companies]: http://pa11y.org/contributing/companies/
|
||||||
|
[designers]: http://pa11y.org/contributing/designers/
|
||||||
|
[developers]: http://pa11y.org/contributing/developers/
|
@@ -82,10 +82,12 @@ The boot configurations for Pa11y Dashboard are as follows. Look at the sample J
|
|||||||
This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [Pa11y Webservice][pa11y-webservice] instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`.
|
This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [Pa11y Webservice][pa11y-webservice] instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`.
|
||||||
|
|
||||||
|
|
||||||
Development
|
Contributing
|
||||||
-----------
|
------------
|
||||||
|
|
||||||
To develop Pa11y Dashboard, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup).
|
There are many ways to contribute to Pa11y Dashboard, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
|
||||||
|
|
||||||
|
If you're ready to contribute some code, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup).
|
||||||
|
|
||||||
You'll need to start the application in test mode with:
|
You'll need to start the application in test mode with:
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user