From c291f8ddf1a1dd8cef66bf81c16469b53b502ad7 Mon Sep 17 00:00:00 2001 From: Frank Chen Date: Sun, 2 Aug 2026 16:41:25 +0800 Subject: [PATCH 1/3] docs: document PR title requirements --- AGENTS.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index bf1bfd379dac..c8e89c685ec8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -41,6 +41,13 @@ Real-time analytics database. Java, Maven, multi-module project. - End every file with a newline. - Don't format changes unnecessarily. +## Pull Requests + +- PR titles targeting `master` must use the Conventional Commits format: `: ` or `(): `. +- 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` From 5cdc60d8a0fad01bc925f55ea71c5af698fab7ea Mon Sep 17 00:00:00 2001 From: Frank Chen Date: Sun, 2 Aug 2026 20:36:32 +0800 Subject: [PATCH 2/3] docs: document breaking PR title format --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AGENTS.md b/AGENTS.md index c8e89c685ec8..4b68cebb0c69 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -44,6 +44,7 @@ Real-time analytics database. Java, Maven, multi-module project. ## Pull Requests - PR titles targeting `master` must use the Conventional Commits format: `: ` or `(): `. +- For a breaking change, add `!` immediately before the colon: `!: ` or `()!: `. 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. From 87c98c87dc0958281aa93356f6a3ee3919449b3f Mon Sep 17 00:00:00 2001 From: Frank Chen Date: Sun, 2 Aug 2026 21:03:18 +0800 Subject: [PATCH 3/3] docs: add PR self-review guidance --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AGENTS.md b/AGENTS.md index 4b68cebb0c69..05e8c49e71a9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -43,6 +43,7 @@ Real-time analytics database. Java, Maven, multi-module project. ## 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: `: ` or `(): `. - For a breaking change, add `!` immediately before the colon: `!: ` or `()!: `. 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`.