Contributing to Spytula¶

Thank you for your interest in contributing to the Spytula project! We welcome contributions from the community to help improve and grow the library. This document provides guidelines and information on how you can contribute effectively.

Ways to Contribute¶

There are several ways you can contribute to the Spytula project:

Report Issues: If you encounter any bugs, issues, or have feature requests, please submit an issue on our GitHub repository. Include as much detail as possible to help us understand and address the problem.
Provide Feedback: If you have feedback or suggestions for improving Spytula, we would love to hear from you. You can share your thoughts by opening a new issue or participating in discussions on existing issues.
Submit Pull Requests: If you'd like to contribute code changes, bug fixes, or new features, you can submit a pull request. Follow the guidelines below to ensure a smooth review and merge process.

Development Setup¶

To set up a development environment for Spytula, follow these steps:

Clone the repository:

git clone https://github.com/example/spytula.git

Install the required dependencies:

cd spytula
poetry install

Run tests to verify the setup:

poetry run pytest

Code Contribution Guidelines¶

When contributing code changes, please adhere to the following guidelines:

Fork the repository and create a new branch for your changes.
Ensure your code follows the existing code style and conventions.
Write clear and concise commit messages. We recommend using conventional commits.
Include tests to cover your changes and ensure they pass.
Update documentation as necessary.
Submit a pull request to the main branch of the main repository.

License¶

By contributing to the Spytula project, you agree that your contributions will be licensed under the MIT License. You retain the copyright to your contributions.

Code of Conduct¶

We expect all contributors to follow the Code of Conduct when contributing to Spytula.