Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (46 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

62 lines (46 loc) · 1.46 KB
Raw

Contributing

Thank you for your interest in contributing! All contributions are welcome.

Getting Started

  1. Fork the repository and clone it locally
  2. Create a feature branch: git checkout -b feat/your-feature
  3. Set up the development environment (see README Quick Start)
  4. Make your changes with tests
  5. Run the test suite: pytest tests/ -v
  6. Submit a Pull Request

Types of Contributions

Type Welcome?
Bug fixes ✅ Always
New features ✅ With discussion
Documentation ✅ Always
Performance improvements ✅ With benchmarks
New AI model integrations ✅ With tests

Code Standards

  • Follow existing code structure and naming conventions
  • Add type hints to all functions
  • Write docstrings for public methods
  • All new features must include tests
  • Keep PRs focused — one feature or fix per PR

Pull Request Template

## What this PR does
Brief description of the change.

## Type of change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation

## Testing
- [ ] Tests added / updated
- [ ] All tests pass: pytest tests/ -v

## Checklist
- [ ] No API keys or secrets committed
- [ ] README updated if needed

Reporting Bugs

Open a GitHub Issue with:

  1. Description of the bug
  2. Steps to reproduce (exact curl command or code)
  3. Expected vs actual behaviour
  4. Environment (Python version, OS)

License

By contributing, you agree your contributions are licensed under the MIT License.