We love your input and feedback! I want to make contributing to this project easy and transparent as possible, whether it's:
- Reporting a bug,
- Dsicussing the current state of the code,
- Submitting a fix,
- Proposing new features,
- Becoming a maintainer
This document should hopefully describe how to contribute to this project.
This project uses Github to host code, track issues and feature requests, and accept pull requests.
Pull requests automatically run unit tests using Github Flow on the proposed changes, so I welcome any contribution as long as it follows these steps:
- Fork the repo and create your branch from the main branch,
- Changes to the code base should also include unit tests and functional tests where possible,
- Ensure that the tests pass,
- Ensure that the code follows linting standards,
- Issue the pull request!
Any changes you make should follow the MIT Software License
Reporting bugs is done using the template provided by Github issues found here