Skip to content

docs: document pull request guidance in AGENTS.md - #19854

Open
FrankChen021 wants to merge 3 commits into
apache:masterfrom
FrankChen021:codex/document-pr-title-requirements
Open

docs: document pull request guidance in AGENTS.md#19854
FrankChen021 wants to merge 3 commits into
apache:masterfrom
FrankChen021:codex/document-pr-title-requirements

Conversation

@FrankChen021

@FrankChen021 FrankChen021 commented Aug 2, 2026

Copy link
Copy Markdown
Member

Description

Document pull request preparation requirements in AGENTS.md so coding agents review their complete change and use a valid title before opening a PR against master.

The new guidance includes:

  • a requirement to self-review the complete diff against the target branch;
  • the supported Conventional Commits title formats, including the ! marker for breaking changes;
  • the accepted types configured by the PR title check;
  • an example title; and
  • a reminder to follow the pull request template when preparing the description.

This helps agents catch unintended or incorrect changes before publishing and avoids preventable failures in the Verify PR title conforms to Conventional Commits check. It does not affect Druid runtime behavior.

Verification

  • Confirmed that the documented types match .github/workflows/pr-checks.yml.
  • Self-reviewed the complete diff against the target branch.
  • Ran git diff --check.
  • No runtime tests were run because this change only updates agent guidance.

This PR has:

  • been self-reviewed.
  • added documentation for a repository contribution requirement.

@FrankChen021 FrankChen021 changed the title docs: document PR title requirements docs: document PR title requirements in AGENTS.md Aug 2, 2026
@FrankChen021
FrankChen021 marked this pull request as ready for review August 2, 2026 08:42
Copilot AI review requested due to automatic review settings August 2, 2026 08:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 FrankChen021 added the Area - Dev For items related to the project itself, like dev docs and checklists, but not CI label Aug 2, 2026

@FrankChen021 FrankChen021 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread AGENTS.md

## Pull Requests

- PR titles targeting `master` must use the Conventional Commits format: `<type>: <description>` or `<type>(<scope>): <description>`.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 FrankChen021 changed the title docs: document PR title requirements in AGENTS.md docs: document pull request guidance in AGENTS.md Aug 2, 2026
@jtuglu1
jtuglu1 self-requested a review August 3, 2026 02:11

@FrankChen021 FrankChen021 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area - Dev For items related to the project itself, like dev docs and checklists, but not CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants