Contributing to TealTiger

May 22, 2026 · View on GitHub

Thank you for considering contributing to TealTiger! It's people like you that make TealTiger a great tool for securing AI agents.

Ways to Contribute

🐛 Report bugs — Help us identify and fix issues
💡 Suggest features — Share ideas for new functionality
📝 Improve documentation — Help others understand and use the SDK
🔧 Submit pull requests — Contribute code improvements
🔍 Add secret detection patterns — Expand our 500+ pattern library
💬 Answer questions — Help other users in Discussions

Getting Started

Which repo?

TealTiger uses separate repos for each SDK:

SDK	Repo	Setup
TypeScript	tealtiger-typescript-prod	`npm install && npm test`
Python	tealtiger-python-prod	`pip install -e ".[dev]" && pytest`

Development Setup

TypeScript SDK:

git clone https://github.com/agentguard-ai/tealtiger-typescript-prod.git
cd tealtiger-typescript-prod
npm install
npm test
npm run build

Python SDK:

git clone https://github.com/agentguard-ai/tealtiger-python-prod.git
cd tealtiger-python-prod
pip install -e ".[dev]"
pytest

Your First PR (Step-by-Step)

Never submitted a PR before? Here's the exact workflow:

1. Fork & Clone

# Fork the repo via GitHub UI, then:
git clone https://github.com/YOUR_USERNAME/tealtiger.git
cd tealtiger

2. Create a Branch

git checkout -b fix/your-change-name

3. Make Your Change

Edit the file(s) you want to change. Start small — typo fixes and doc improvements count!

4. Test Locally

# TypeScript SDK
cd tealtiger-typescript-prod
npm install && npm test

# Python SDK
cd tealtiger-python-prod
pip install -e ".[dev]" && pytest

5. Commit & Push

git add .
git commit -m "docs: fix typo in CONTRIBUTING.md"
git push origin fix/your-change-name

6. Open a PR

Go to your fork on GitHub
Click "Compare & pull request"
Fill out the PR template — reviewers look for: clear description, tests passing, scope focused
Submit and wait for review (typically 2–3 business days)

Development Workflow

1. Create a branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

Branch naming: feature/, fix/, docs/, refactor/, test/

2. Make your changes

Follow the existing code style
Add tests for new functionality
Update documentation as needed

3. Test

# TypeScript
npm test
npm run lint

# Python
pytest
ruff check .

4. Commit

We follow Conventional Commits:

git commit -m "feat: add Twilio secret detection pattern"
git commit -m "fix: resolve timeout in TealCircuit"
git commit -m "docs: add CrewAI integration example"