This is an automated email from the ASF dual-hosted git repository.
pvary pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/main by this push:
new 7e3fe2f935 Docs: Require Checkstyle validation in agent instructions
(#18306)
7e3fe2f935 is described below
commit 7e3fe2f935540ed4c4a8dc8715d7236a64e62ee3
Author: Manu Zhang <[email protected]>
AuthorDate: Wed Sep 30 17:05:20 2026 +0800
Docs: Require Checkstyle validation in agent instructions (#18306)
Generated-by: Codex (GPT-6)
---
AGENTS.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/AGENTS.md b/AGENTS.md
index 8591201b38..ae33d25bc1 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -209,6 +209,7 @@ CloseableIterable<FileScanTask> planFiles();
- **Spark-versioned module:** `./gradlew
:iceberg-spark:iceberg-spark-4.1_2.13:test --tests
"org.apache.iceberg.spark.source.TestSparkReaderDeletes"`
- **Format code:** `./gradlew spotlessApply`
- **Check formatting:** `./gradlew spotlessCheck`
+- **Checkstyle (core module):** `./gradlew :iceberg-core:checkstyleMain
:iceberg-core:checkstyleTest` (replace the module path for other modules).
- **API compatibility:** `./gradlew revApiCheck`
## PR & Commit Conventions
@@ -218,7 +219,7 @@ CloseableIterable<FileScanTask> planFiles();
- PR titles follow `Module: Description` format (e.g., `Core: Fix ...`,
`Spark: Add ...`, `Docs: Update ...`).
- One concern per PR. Unrelated whitespace, import, or formatting changes go
in separate PRs.
- Keep first version of a PR minimal — defer recovery, optimization, and edge
cases to follow-ups.
-- Before opening a PR, run `./gradlew spotlessApply` and build and test the
modules you changed (see Commands). Never submit code you have not compiled and
run.
+- Before opening a PR, run `./gradlew spotlessApply`, run `checkstyleMain` and
`checkstyleTest` for the modules you changed, and build and test those modules
(see Commands). Never submit code you have not compiled and run.
- PR description is one paragraph, under 120 words: the problem, the approach,
and anything a reviewer would not guess from the diff. Plus the issue link, the
test plan, and the AI Disclosure block. Nothing else.
- Never restate the diff: no file-by-file walkthrough, no per-method
summaries, no "Changes made" checklist, no "Summary", "Background",
"Motivation", or "Testing" headings, no emoji.
- Commit messages describe the *what* and *why*, not implementation details.
