diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0a1ac0d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +## Contributing + +Contributions are welcome! To contribute to this project: + +1. **Fork the repository** and clone your fork locally. +2. **Create a new branch** for your feature or bugfix: + ```bash + git checkout -b my-feature + ``` +3. **Install dependencies** using Poetry: + ```bash + poetry install + ``` +4. **Make your changes** and add tests as needed. +5. **Run tests** to ensure everything works: + ```bash + poetry run pytest + ``` +6. **Format your code** with Black: + ```bash + poetry run black . + ``` +7. **Commit and push** your changes to your fork. +8. **Open a pull request** describing your changes. + +Please follow the existing code style and add tests for new features or bugfixes.