Skip to content

Commit efe792a

Browse files
committed
add instructions to not include issue number or anything in PR title
1 parent 8445422 commit efe792a

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ 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`
175+
- **Bad:** `Initialize Dag bundles in CLI get_dag function(#12345)`
176176
- **Bad:** `fix(cli): dags test failure` — Airflow does not use Conventional Commits
177177
(`feat:`, `fix:`, `chore:` …). Write the subject as plain prose. A `commit-msg`
178178
prek hook (`check-no-conventional-commit-message`) rejects these, and CI checks
@@ -188,6 +188,8 @@ Use the **imperative mood** and a plain message — do **not** use Conventional
188188
convention. (Area tags the project already uses, like `UI:` / `API:` / `Helm:`, are fine;
189189
Conventional-Commit `type:` tokens are not.) The same rule applies to PR titles.
190190

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.
192+
191193
The commit message **body** should describe **why** the change is made — the motivation and
192194
context — and **never what** the change is. The diff already shows what changed; restating it in
193195
prose adds noise.

0 commit comments

Comments
 (0)