Thank you for your interest in contributing! This document provides guidelines for contributing to the project.
- Be respectful and inclusive
- Welcome newcomers
- Focus on constructive feedback
- Fork the repository
- Clone your fork
- Create a virtual environment
- Install dependencies:
pip install -r requirements.txt - Make your changes
- Test thoroughly
- Submit a pull request
- Follow PEP 8 style guide
- Add type hints where appropriate
- Write clear docstrings
- Update documentation for new features
- Add tests for new functionality
- Update README.md if needed
- Update CHANGELOG.md with your changes
- Ensure all tests pass
- Request review from maintainers
Open an issue or start a discussion!