Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (22 loc) · 677 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 677 Bytes

Contributing to shadowmap

Thank you for your interest in contributing!

How to Contribute

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes with tests
  4. Commit with a descriptive message
  5. Open a Pull Request

Development Setup

git clone https://github.com/rawqubit/shadowmap.git
cd shadowmap
pip install -r requirements.txt
export OPENAI_API_KEY="your-key"

Code Style

  • Follow PEP 8
  • Add type hints to all functions
  • Write docstrings for public functions
  • Add tests for new functionality

Reporting Issues

Please use GitHub Issues with a clear description and reproduction steps.