We love your input! 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
We use github to host code, to track issues and feature requests, as well as accept pull requests.
- Fork the repo and create your branch from
main
. - If you've added code that should be commented for information
- Make sure your code lints.
- commit with simple information, example:
docs: adding documentation or fixing documentation
fix: fix some code with change minor and major
update: update more spesific code for more efficient
- push with your prject branch
git push origin your_custom_branch
start description of pull request, try to speak well, respectfully, and say hello, and provide detailed explanations that are easy to read and understand with the example
## description
explain your changes with detail information
## change
code example of changes
thanks !!
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 or some question using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.
By contributing, you agree that your contributions will be licensed under its MIT License.