Open Agent Toolkit

Contributing

Use this section when you are changing OAT itself rather than consuming it as a user. It routes you to the right contributor contract for code changes, docs updates, markdown authoring patterns, and skill development.

Contents

  • Contributing Code - Repo setup, monorepo structure, quality gates, and PR expectations.
  • Contributing Docs - Docs contract, local docs workflow, and docs-specific authoring guidance.
  • Markdown Features - Supported docs syntax for callouts, tabs, Mermaid, and code blocks.
  • Writing Skills - Skill authoring guidance, runtime contracts, and governance.
  • CLI Design Principles - Cross-cutting CLI architecture and UX principles.
  • Commit Conventions - Traceable commit patterns for project and docs work.
  • Hooks and Safety - Safety and mutation contracts for provider-sync behavior.
  • Smoke Testing - Runbook for the live workflow smoke runner: prerequisites, scenarios, evidence reports, and recovery.
  • Verifying Explainer Kit - Golden recap cases, real-Chromium evidence, fixture regeneration, and release validation.
  • Verifying Cursor Pins - Runbook for probe-verifying a Cursor model pin before shipping it.

On this page