CONTRIBUTING.md

Contribution Guideline

Thanks for interesting my project and taking your time to contribute! 🥰

• Bug Report or Feature Request
• Submitting Changes
  • Setup Development
• Pull Requests

Bug Report or Feature Request

If you find a bug or want a feature, please open an issue on GitHub. Include as much detail as possible.

Submitting Changes

1. Fork the repository and clone it locally.
2. Setup development environment as described as below
3. Create a new feature or bugfix branch.
4. Commit and push your changes to your forked repository.
5. Open a pull request on GitHub.

Setup Development Environment

hatch -e dev env create
hatch -e dev shell
pre-commit install

Pull Requests

• Make sure all python venv related files are removed.