Skip to content

Commit e527c88

Browse files
committed
update hash , example and paragraph
1 parent efe792a commit e527c88

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,9 @@ Write commit messages focused on user impact, not implementation details.
172172

173173
- **Good:** `Fix airflow dags test command failure without serialized Dags`
174174
- **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)`
176178
- **Bad:** `fix(cli): dags test failure` — Airflow does not use Conventional Commits
177179
(`feat:`, `fix:`, `chore:` …). Write the subject as plain prose. A `commit-msg`
178180
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
188190
convention. (Area tags the project already uses, like `UI:` / `API:` / `Helm:`, are fine;
189191
Conventional-Commit `type:` tokens are not.) The same rule applies to PR titles.
190192

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
192200

193201
The commit message **body** should describe **why** the change is made — the motivation and
194202
context — and **never what** the change is. The diff already shows what changed; restating it in

dev/skill-evals/last-eval-hash.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Generated by dev/skill-evals/eval.py — do not edit or resolve conflicts by hand.
22
# Run `prek run run-skill-eval --hook-stage manual --all-files` to regenerate.
3-
8cfe725b810c4c2d364d99f63b27ec739545e40032195624c218b0eb23d75859
3+
1e22caec87595e573e6281b901cb6a3d2b16a6c82432d5d281bb7f8b6a455d46

0 commit comments

Comments
 (0)