Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests. You can send a pull request by following the steps below.
-
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 repo and create your branch from
main
. -
If you've added code that should be tested, run the tests.
-
Add Proper Documentation. Docstring should be added to the added/modified
.py
files. If you're adding a new class to be initialized, please mention the initialization to theREADME.md
within the directory. -
Once everything is done, create a Pull Request. Wait for review to resolve any problems, and merging.
By contributing, you agree that your contributions will be licensed under its MIT License.