I'd love your input! Contributing to this project should be as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
I have adopted a Code of Conduct that I expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
If you're curious about a feature, the state of development, want to adapt this project for another use-case, or have anything else on your mind feel free to head over to the discussions page. This will be the best place to discuss topics in detail.
The typical Github Flow is employed here. So, all code changes happen through pull requests. Pull requests are the best way to propose changes to the codebase. I'll actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github's issues
GitHub issues is used to track bugs. Report a bug by opening a new issue; it's that easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. I'm not even kidding.
This project employs several linters to ensure a consistent coding style:
By contributing, you agree that your contributions will be licensed under its MIT License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft