docs(agents): document Dag naming convention#66393
Merged
Lee-W merged 3 commits intoapache:mainfrom May 5, 2026
Merged
Conversation
Add a Naming section to AGENTS.md explaining that prose, comments, docstrings, commit messages, and PR text always use "Dag" (title case), and list the legitimate exceptions where the literal form must be preserved: Python code tokens with the legacy `DAG` class, CLI subcommands like `airflow dags list`, file/directory tokens, and anti-pattern callouts that quote the wrong form to teach the rule. Also note that "Directed Acyclic Graph" should not appear except as historical context.
Lee-W
requested review from
amoghrajesh,
ashb,
choo121600,
jason810496,
jscheffl,
kaxil,
potiuk and
shahar1
as code owners
boring-cyborg
Bot
added
area:dev-tools
area:providers
backport-to-v3-2-test
jason810496
approved these changes
May 5, 2026
Member
jason810496
left a comment
jason810496
left a comment
There was a problem hiding this comment.
Thanks! LGTM for the catch.
Contributor
Backport failed to create: v3-2-test. View the failure log Run detailsNote: As of Merging PRs targeted for Airflow 3.X In matter of doubt please ask in #release-management Slack channel.
You can attempt to backport this manually by running: cherry_picker 2a89e90 v3-2-testThis should apply the commit to the v3-2-test branch and leave the commit in conflict state marking After you have resolved the conflicts, you can continue the backport process by running: cherry_picker --continueIf you don't have cherry-picker installed, see the installation guide. |
1 task
ashb
added a commit
to astronomer/airflow
that referenced
this pull request
May 5, 2026
shahar1
pushed a commit
that referenced
this pull request
May 6, 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.
Why
Codify the project-wide convention that "Dag" (title case) is the only correct form in prose, comments, commit messages, and PR text. "DAG" (all caps) appearing in documentation is the legacy form to be replaced; the
DAGPython class itself is current and stays as-is in code. Without an explicit rule in the agent instructions, AI-assisted contributions repeatedly reintroduce the all-caps form.What
AGENTS.mdcovering Dag usage, the legitimate exceptions (Python code tokens, CLI subcommands likeairflow dags list, file/directory tokens, anti-pattern callouts that quote the wrong form to teach the rule), and the rule that "Directed Acyclic Graph" should not appear except as historical context.providers/AGENTS.md..github/skills/airflow-translations/locales/th.mdso its "Keep in English" entries and translation pattern examples use "Dag" instead of "DAG".Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code following the guidelines
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.