Skip to main content

Contributing

Development Principles

  • preserve documented public behavior
  • keep provider integrations isolated from framework abstractions
  • add tests for new primitives and runtime behavior
  • update user-facing docs when APIs or behavior change

Breaking Changes And RFCs

  • breaking changes require an RFC before merge
  • RFC process and template live in:
    • ai-agent-framework/docs/rfcs/README.md
    • ai-agent-framework/docs/rfcs/0000-template.md
  • accepted breaking changes must update:
    • versioned core contract doc
    • migration notes/changelog

Before Opening A Pull Request

pnpm lint
pnpm test --run
pnpm --filter @ai-agent-framework/core build
pnpm --filter @ai-agent-framework/openai build