Thank you for considering contributing to our project! We welcome contributions, whether it's through bug fixes, new features, documentation improvements, or other suggestions. To help you get started, we've created this guide for contributing.
If you've encountered a bug or have a question about the project, please check the existing issues to see if it has already been reported. If not, open a new issue, and be sure to provide as much detail as possible, including:
- Steps to reproduce the issue
- Expected vs. actual behavior
- Any relevant screenshots or error messages
If you have an idea for a new feature or improvement, please open an issue and describe the enhancement in detail. Be sure to explain why it's beneficial to the project.
We accept contributions in the form of pull requests. Here's how you can submit one:
- Fork the repository to your own GitHub account.
- Clone your fork to your local machine.
- Create a new branch for your changes (
git checkout -b my-feature-branch). - Make your changes and commit them with a meaningful message (
git commit -m "Add new feature"). - Push your changes to your fork (
git push origin my-feature-branch). - Create a pull request from your branch to the
mainbranch of the original repository.
- Follow the existing code style in the project (indentation, variable names, etc.).
- Ensure that your code passes the project's tests before submitting a PR.
If you're adding a new feature or fixing a bug, make sure to add relevant tests. You can run the existing tests by using pytest (or any other testing framework the project uses).
Please update the documentation if your changes affect how the project is used or configured. This includes both the README and any other documentation files.
We are committed to providing a welcoming and inclusive environment for all contributors.
We appreciate your time and contributions! 🎉