CONTRIBUTING.md

Contributing to ml-agent

Creating a Pull Request

1. Create and work on your branch

# Create a new branch
git checkout -b your-feature-branch

# Make your changes, then commit
git add .
git commit -m "Your commit message"

2. Push your branch to keep changes backed up

# First time pushing this branch
git push --set-upstream origin your-feature-branch

# Subsequent pushes
git push

3. When ready, create a Pull Request

./create-pr.sh "Your PR title" "Optional description"

# This automatically:
# - Gets your current branch
# - Creates the PR
# - Pushes your changes to it

Example workflow

# 1. Create branch
git checkout -b fix-bug-123

# 2. Make changes and commit
git add backend/main.py
git commit -m "Fix authentication bug"

# 3. Push to keep changes safe
git push --set-upstream origin fix-bug-123

# 4. Continue working...
git add frontend/src/App.tsx
git commit -m "Update UI"
git push

# 5. When ready, create PR
./create-pr.sh "Fix authentication bug" "Fixes issue where users could not authenticate in dev mode"

Development Setup

Running locally with hot-reload

Backend:

cd backend
uv run uvicorn main:app --host 0.0.0.0 --port 7860 --reload

Frontend (in a separate terminal):

cd frontend
npm run dev

Access the app at http://localhost:5173

Environment Variables

Make sure your .env file in the project root contains:

ANTHROPIC_API_KEY=your_key_here
HF_TOKEN=your_hf_token_here
GITHUB_TOKEN=your_github_token_here
HF_NAMESPACE=your_namespace_here