CONTRIBUTING.md

👥 Contributing Guide

I appreciate your interest in contributing to the project! This document outlines how to contribute to the project, including the contribution process, code style, and testing.

🔄️ Contribution process

To contribute, please follow these steps:

1. Fork the project repository on GitHub.

2. Create a new branch for your feature or bug fix.

3. Setup development environment.

   # install pipx
   python3 -m pip install --user pipx
   pipx ensurepath
   
   # install poetry + plugins
   pipx install poetry
   pipx inject poetry poetry-plugin-up
   pipx inject poetry poetry-dynamic-versioning
   pipx inject poetry poethepoet
   
   # install project dependencies
   poetry install
   
   # bump dependencies to the latest
   poetry up --latest
   
   # do test build
   poetry build

4. Make your changes.

5. Lint and validate your code.

   poetry run pre-commit run --all-files

6. Commit your changes.

7. Make sure the README.md and any other relevant documentation are kept up-to-date.

8. Make your changes and commit them with descriptive commit messages; check Conventional Commits as a suggestion.

9. Push to your forked repository.

10. Create a new pull request from your fork to this project.

11. Please ensure that your pull request includes a detailed description of your changes and that your code adheres to the code style guidelines outlined below.

🔰 Code of Conduct

All contributors are expected to adhere to the project name code of conduct. Therefore, please review it before contributing Code of Conduct.

📄 License

By contributing to this project, you agree that your contributions will be licensed under the project license.

Thank you for contributing!