Skip to content

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

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
FrankChen021 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c291f8d
docs: document PR title requirements
FrankChen021 Aug 2, 2026
5cdc60d
docs: document breaking PR title format
FrankChen021 Aug 2, 2026
87c98c8
docs: add PR self-review guidance
FrankChen021 Aug 2, 2026
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
9 changes: 9 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ Real-time analytics database. Java, Maven, multi-module project.
- End every file with a newline.
- Don't format changes unnecessarily.

## Pull Requests

- Before opening a PR, self-review the complete diff against the target branch. Verify that every change is intentional and in scope, check for correctness and regressions, and run the relevant tests or checks.
- PR titles targeting `master` must use the Conventional Commits format: `<type>: <description>` or `<type>(<scope>): <description>`.

@FrankChen021 FrankChen021 Aug 2, 2026

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.

@FrankChen021 FrankChen021 Aug 2, 2026

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.

- For a breaking change, add `!` immediately before the colon: `<type>!: <description>` or `<type>(<scope>)!: <description>`. A breaking change is backward-incompatible and may require users to update existing code, configuration, or integrations.
- Accepted types are `backport`, `build`, `ci`, `dev`, `docs`, `feat`, `fix`, `minor`, `perf`, `refactor`, `release`, `revert`, `style`, and `test`.
- Example: `build: remove redundant license download step`.
- Follow `.github/pull_request_template.md` when preparing the PR description.

## Running Tests

Use these flags for faster tests: `-Pskip-static-checks -Dweb.console.skip=true -T1C`
Expand Down
Loading