Firstly, thanks for being here. All types of contributions are valued and gratefully received. Please consider how you may be able to contribute:
We are grateful to all our funders. Would you like to make a donation?
Your idea for a feature addition may already exist on our issues backlog. If you find it, join the conversation.
If the gist of your idea isn't there:
- add an issue
- to discuss your idea privately, contact us
If you encounter a problem, please add an issue. Make sure it hasn't already be reported.
In order for us to best respond to the issue, we need as much information about the issue as you can provide. Please provide:
- as much detail as possible in the issue template.
- a descriptive name for your issue.
We may add or change labels on your issue to help us manage the issue backlog.
Documentation helps people use and contribute to the work we do. You may like to:
- improve the Readme.md
- add or improve other documentation in this repository
- write a Guide, Blog post or even Tweet
This work is open source, and we are grateful to all our contributors. By participating in this project, you agree to abide by our Code of Conduct.
Before you start coding, please reach out to us to discuss how you can help.
If this is your first time contributing code, you will need to create a fork of this repository.
Follow the readme instructions to get your development environment running locally.
Ensure that all automated tests pass before starting work on your contribution.
All contributions to the codebase will be reviewed. To increase your chances of your code being accepted please be aware of the following:
- Write well formed commit messages
- Write tests for all changes (additions or refactors of existing code).
- We may use GitHub integrations to check your contribution.
- Once your Pull Request (PR) is published and passes the above checks a repository administrator will review your contribution. Where appropriate, comments will be provided and amendments suggested before your PR is merged into Master.