Add AGENTS.md to common AI provider#62824
Merged
Merged
Conversation
Guide AI coding tools and contributors toward the right design decisions: delegate to pydantic-ai instead of re-implementing provider-specific logic, keep the hook thin, avoid premature abstractions like builder patterns or registries. Motivated by PR apache#62816 which added ~280 lines of Azure OpenAI builder code that duplicated what pydantic-ai's AzureProvider already handles natively.
gopidesupavan
approved these changes
Mar 3, 2026
dominikhei
pushed a commit
to dominikhei/airflow
that referenced
this pull request
Mar 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
providers/common/ai/AGENTS.mdto guide AI coding tools and contributors toward correct design decisions when working on the common AI provider.Why
PR #62816 added ~280 lines of Azure OpenAI builder/factory code that duplicated what pydantic-ai's
AzureProvideralready handles natively. An AGENTS.md in the provider directory would have steered the contributor (and AI coding tools like Cursor, Claude Code, Copilot) toward the simpler approach from the start.What the file covers
get_conn()branch if neededcommon.compatfor SDK importsFollows the style of
airflow-core/src/airflow/api_fastapi/execution_api/AGENTS.md— domain-specific and concise, not generic setup. The rootproviders/AGENTS.mdalready covers general provider conventions.