Skip to content

Instruct AI agents not to include issue tracker in PR title #71327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Prab-27 wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −1
Open

Instruct AI agents not to include issue tracker in PR title #71327

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Write commit messages focused on user impact, not implementation details.

- **Good:** `Fix airflow dags test command failure without serialized Dags`
- **Good:** `UI: Fix Grid view not refreshing after task actions`
- **Bad:** `Initialize Dag bundles in CLI get_dag function`
- **Bad:** `Initialize Dag bundles in CLI get_dag function(#12345)`
- **Bad:** `fix(cli): dags test failure` — Airflow does not use Conventional Commits
(`feat:`, `fix:`, `chore:` …). Write the subject as plain prose. A `commit-msg`
prek hook (`check-no-conventional-commit-message`) rejects these, and CI checks
Expand All @@ -188,6 +188,8 @@ Use the **imperative mood** and a plain message — do **not** use Conventional
convention. (Area tags the project already uses, like `UI:` / `API:` / `Helm:`, are fine;
Conventional-Commit `type:` tokens are not.) The same rule applies to PR titles.

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.

The commit message **body** should describe **why** the change is made — the motivation and
context — and **never what** the change is. The diff already shows what changed; restating it in
prose adds noise.
Expand Down
Loading