-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing
MarkelZ edited this page Aug 14, 2023
·
3 revisions
Thank you for considering contributing to our project! Every contribution helps make our package better for everyone.
All forms of contributions are welcome:
- Bug Reports: If you encounter a bug or notice something that needs improvement, please let us know by creating an issue in the issue tracker.
- Code Contributions: You can directly contribute by fixing bugs or implementing new features. Check our list of open issues to see if there's something you'd like to work on.
- Feature Requests: If you have ideas for new features or improvements, don't hesitate to share them. You can open an issue in the issue tracker.
- Documentation Improvements: If you notice any gaps, inconsistencies, or areas that need improvement in our documentation, you can help by submitting a pull request to update it.
To submit your contribution, follow these steps:
- Fork the repository to your GitHub account.
- Create a new branch for your changes, with a descriptive name.
- Make your changes and commit them with clear messages.
- Push your changes to your fork.
- Create a pull request (PR) from your branch in your fork to the main branch of our repository.
When contributing code, we request that you adhere to the following guidelines:
- Follow the PEP 8 standards: https://peps.python.org/pep-0008/
- Write clear and concise commit messages.
- The changes should be tested whenever possible.
Thank you for your support!