This repository has been archived by the owner on Sep 29, 2024. It is now read-only.

Contributing

Submitting contributions

Create a fork of the repository.
Make your changes. Make a pull request per feature/change!
- Do not make a "fix stuff" PR with a million files changed. Instead provide a description of the changes and keep it simple.
- Do not make a "add <feature 1> and improve <feature 2>" PR. Make one for <feature 1> and one for improving the <feature 2>.
When your contribution is ready to be integrated, create a pull request.
In the pull request description, detail the changes your contribution made including any bugs fixed, features added, etc.

Suggesting features/improvements

Create a new issue.
In the description detail the feature's design specifications along with the acceptance criteria for the feature.
Submit the issue.
Be sure to follow up the issue over time by reading and responding to comments, as that will be the primary means of communicating on the progress of the issue.

Reporting bugs

Create a new issue.
In the description provide the following:
- Detailed description of the buggy behavior.
- As many reproduction steps as you can provide.
- Optionally a fix that you found.
Submit the issue.
Be sure to follow up the issue over time by reading and responding to comments, as that will be the primary means of communicating on the progress of the issue.