Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (79 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

110 lines (79 loc) · 1.96 KB

Contributing to traceAI

Thanks for your interest in contributing! 🎉

Quick Start

  1. Fork & Clone

    git clone https://github.com/YOUR_USERNAME/traceAI.git
cd traceAI

  2. Create a branch

    git checkout -b feature/your-feature

  3. Make changes & test

  4. Commit (use Conventional Commits)

    git commit -m "feat: add xyz support"

  5. Push & open a PR

    git push origin feature/your-feature

Development Setup

Python

cd python
poetry install              # Install core
cd frameworks/openai        # Work on specific framework
poetry install
pytest                      # Run tests

Code Quality: Black, isort, flake8, mypy

TypeScript

cd typescript
pnpm install                # Install all packages
pnpm run build              # Build
pnpm test                   # Run tests

Code Quality: ESLint, Prettier, TypeScript strict mode

Adding a New Framework

Python

mkdir python/frameworks/your-framework
cd python/frameworks/your-framework

Create structure:

traceai_your_framework/
├── __init__.py
├── instrumentation.py
└── version.py
tests/
examples/
pyproject.toml
CHANGELOG.md
README.md

TypeScript

mkdir typescript/packages/traceai_your_framework

Create structure similar to existing packages, then update pnpm-workspace.yaml.

Don't forget: Update main README with your new integration!

Guidelines

  • ✅ Write tests for all changes
  • ✅ Follow existing code style
  • ✅ Update documentation
  • ✅ Update CHANGELOG.md
  • ✅ Keep PRs focused and small

Need Help?

Happy Contributing! 🚀