Hello! 👋
We would love to accept your contribution to this project. We want to make contributing to this project 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
- 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 pulls request!
Submit a bug report with detail, background, and sample code. You can refer to this example from Craig Hockenberry.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give a sample code if you can.
- What you expected would happen
- What is happening
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)