docs: document pull request guidance in AGENTS.md - #19854
Conversation
There was a problem hiding this comment.
🟢 Ready to approve
Documentation-only change that matches the current PR title check configuration and references an existing PR template path.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Updates contributor/agent guidance in AGENTS.md to document the PR title format enforced for PRs targeting master, helping avoid failures from the “Verify PR title conforms to Conventional Commits” GitHub Actions check.
Changes:
- Added a “Pull Requests” section describing the Conventional Commits PR title formats accepted for
master. - Documented the exact allowed PR title types and provided an example title.
- Referenced the PR description template to encourage consistent PR descriptions.
File summaries
| File | Description |
|---|---|
| AGENTS.md | Adds PR title requirements (Conventional Commits + allowed types) and links to the PR template for descriptions. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
FrankChen021
left a comment
There was a problem hiding this comment.
| Severity | Findings |
|---|---|
| P0 | 0 |
| P1 | 0 |
| P2 | 1 |
| P3 | 0 |
| Total | 1 |
| Severity | Findings |
|---|---|
| P0 | 0 |
| P1 | 0 |
| P2 | 1 |
| P3 | 0 |
| Total | 1 |
Reviewed 1 of 1 changed files. Found one omission in the mandatory Conventional Commits title forms.
This is an automated review by Codex GPT-5.6-Sol
|
|
||
| ## Pull Requests | ||
|
|
||
| - PR titles targeting `master` must use the Conventional Commits format: `<type>: <description>` or `<type>(<scope>): <description>`. |
There was a problem hiding this comment.
[P2] Document breaking-change title variants
The v6 title-check action accepts breaking-change titles such as refactor!: ..., and Conventional Commits also permits <type>(<scope>)!: .... This new mandatory rule omits both forms. Agents following it for a breaking PR will drop the !, preventing release automation that consumes the title from recognizing the breaking change. Include both ! variants.
There was a problem hiding this comment.
Good catch. Updated AGENTS.md in 5cdc60d to document both breaking-change title variants (type!: description and type(scope)!: description) and clarify that ! is for backward-incompatible changes that may require users to update existing code, configuration, or integrations.
FrankChen021
left a comment
There was a problem hiding this comment.
I reviewed the updated Conventional Commits guidance against the title-check workflow and surrounding contribution documentation; no issues found. The previous title-variant omission is resolved.
Reviewed 1 of 1 changed files.
This is an automated review by Codex GPT-5.6-Sol
Description
Document pull request preparation requirements in
AGENTS.mdso coding agents review their complete change and use a valid title before opening a PR againstmaster.The new guidance includes:
!marker for breaking changes;This helps agents catch unintended or incorrect changes before publishing and avoids preventable failures in the
Verify PR title conforms to Conventional Commitscheck. It does not affect Druid runtime behavior.Verification
.github/workflows/pr-checks.yml.git diff --check.This PR has: