Hi there! I am thrilled that you'd like to contribute to this project.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! I'd love all and any contributions. If you have questions, I'd love to hear them as well.
It would be awesome if you could open an issue in case you would like to raise a PR and discuss first.
Please keep the below in mind when you are creating issues/prs.
-
With issues:
- Use the search tool before opening a new issue.
- In case of a bug, please provide step by step instructions about how to reproduce it.
- Review existing issues and provide feedback or react to them.
-
With pull requests:
- Open your pull request against
main - Your pull request should have no more than two commits, if not you should squash them.
- You should add/modify tests to cover your proposed code changes.
- If you are adding a new feature, please discuss if first.
- Open your pull request against
- When it comes to priority
- Fixing bugs if any has the highest priority - duh!
- Finishing off the list of items from the todo list in readme.md has the next highest priority.