We welcome contributions of all kinds, from bug reports and feature requests to code improvements and new features.
- Fork the repository: Create a fork of the project on GitHub.
- Clone your fork: Clone your forked repository to your local machine.
- Create a new branch: Create a new branch for your feature or bug fix.
- Please adhere to the project's coding style (e.g., PEP 8).
- Write clear and concise code with meaningful comments.
- Test your changes thoroughly.
Incase of adding tests to this project, we'd advice this be done using python's default unittest, inorder not to convulte the codebase.
- Commit your changes: Commit your changes with clear and descriptive commit messages.
- Push to your fork: Push your changes to your forked repository.
- Create a pull request: Open a pull request to the main repository, explaining your changes in detail.
We appreciate your contributions!
Additional Tips:
- Consider using a linter to enforce code style consistency.
- Provide clear and concise commit messages.
- Be open to feedback and suggestions.
- By following these guidelines, you can help improve the project for everyone.