CONTRIBUTING.md

🤝 Contributing to CodeCanvas

Thank you for your interest in contributing to CodeCanvas! This document provides guidelines for contributing.

📋 How to Contribute

Reporting Bugs 🐛

1. Check if the bug has already been reported in Issues
2. If not, create a new issue with:
   • Clear title and description
   • Minimal reproducible code
   • Expected vs actual behavior
   • Environment info (OS, Python version, Pillow version)
   • Screenshots if applicable

Suggesting Features 💡

1. Open an issue with the [Feature] label
2. Describe the feature and its use case
3. If possible, provide example code showing how the feature would be used

Submitting Pull Requests 📝

1. Fork the repository
2. Create a feature branch: git checkout -b feature/your-feature-name
3. Write code following PEP 8 style guidelines
4. Add tests for new functionality
5. Update documentation if needed
6. Commit with conventional commit messages:
   • feat: add new feature
   • fix: fix bug
   • docs: update documentation
   • refactor: code refactoring
   • test: add tests
   • chore: maintenance tasks
7. Push and create a Pull Request

🏗️ Development Setup

# Clone the repository
git clone https://github.com/gitstq/CodeCanvas.git
cd CodeCanvas

# Install dependencies
pip install -e ".[dev]"

# Run tests
pytest tests/ -v

# Run demo
python examples/demo.py

📐 Code Style

• Follow PEP 8
• Use type hints
• Add docstrings to all public functions and classes
• Keep functions focused and small
• Handle errors gracefully

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.