You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,7 +172,9 @@ Write commit messages focused on user impact, not implementation details.
172
172
173
173
-**Good:**`Fix airflow dags test command failure without serialized Dags`
174
174
-**Good:**`UI: Fix Grid view not refreshing after task actions`
175
-
-**Bad:**`Initialize Dag bundles in CLI get_dag function(#12345)`
175
+
-**Good:**`Update foo function`
176
+
-**Bad:**`Initialize Dag bundles in CLI get_dag function`
177
+
-**Bad:**`Update foo function (#12345)`
176
178
-**Bad:**`fix(cli): dags test failure` — Airflow does not use Conventional Commits
177
179
(`feat:`, `fix:`, `chore:` …). Write the subject as plain prose. A `commit-msg`
178
180
prek hook (`check-no-conventional-commit-message`) rejects these, and CI checks
@@ -188,7 +190,13 @@ Use the **imperative mood** and a plain message — do **not** use Conventional
188
190
convention. (Area tags the project already uses, like `UI:` / `API:` / `Helm:`, are fine;
189
191
Conventional-Commit `type:` tokens are not.) The same rule applies to PR titles.
190
192
191
-
Do not include the issue number, a commit hash, or any other tracking identifier in the title (e.g. `(#12345)` or a trailing hash) — reference the issue in the PR **body** instead, using `closes: #ISSUE` or `related: #ISSUE`, so GitHub auto-links it.
193
+
Do not include an issue or PR number in the PR title. GitHub already appends
194
+
the actual PR number automatically when a PR is squash-merged (this is why
195
+
Airflow's git history is full of titles like `... (#71609)`). Manually
196
+
adding a number in the title duplicates that auto-added number, and readers
197
+
cannot tell whether the number in the title refers to an issue or a PR —
198
+
which is misleading in the commit history and changelog. Reference the
199
+
issue only in the PR description, not the title
192
200
193
201
The commit message **body** should describe **why** the change is made — the motivation and
194
202
context — and **never what** the change is. The diff already shows what changed; restating it in
0 commit comments