Contributing to an open source project is a great way to improve your skills. It gives you a good idea about the entire process of github, how to deal with pull requests, reviews, everything!
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
- Once you figure out what to contribute, open an issue at Issues. Make sure that the issue is detailed with respect to your contribution.
- Fork the repository This can be done by the 'Fork' button on the top right corner of the page.
-
If you've added code that should be tested, run the tests.
-
Add Proper Documentation. Docstring should be added to the added/modified
.pyfiles. Make your code as readable as possible. -
Once everything is done, create a Pull Request! Wait for reviews to resolve any problems, and merge!
By contributing, you agree that your contributions will be licensed under the projects MIT License.