This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/paimon.git
The following commit(s) were added to refs/heads/master by this push:
new 676a4a2609 [BUILD] Add `AGENTS.md` (#7297)
676a4a2609 is described below
commit 676a4a2609e570f2e0d70fa2737b457e71205b1d
Author: Zouxxyy <[email protected]>
AuthorDate: Wed Feb 25 10:21:25 2026 +0800
[BUILD] Add `AGENTS.md` (#7297)
---
AGENTS.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
pom.xml | 3 +--
2 files changed, 53 insertions(+), 2 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000000..5df1c75628
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,52 @@
+# Apache Paimon
+
+This file provides context and guidelines for AI coding assistants working
with the Apache Paimon codebase.
+
+## Syntax Requirements
+
+- Based on JDK 8 and Scala 2.12, higher version syntax features must not be
used.
+
+## Build and Test
+
+Prefer the smallest possible build/test scope and use the local iteration
speedup techniques below to keep feedback loops fast.
+
+### Build
+
+Prefer using Maven module selection to minimize the build scope.
+
+- Compile a single module: `mvn -pl <module> -DskipTests compile`
+- Compile multiple modules: `mvn -pl <module1>,<module2> -DskipTests compile`
+
+### Test
+
+Prefer running the narrowest tests.
+
+- Run test for a single method: `mvn -pl <module>
-Dtest=TestClassName#methodName test`
+- Run test for a single class: `mvn -pl <module> -Dtest=TestClassName test`
+
+### Local Iteration Speedup
+
+#### Use Maven Skip Options
+
+Prefer these skip options for faster local iteration, but don't rely on them
for final verification.
+
+```shell
+-Dcheckstyle.skip -Dspotless.check.skip -Denforcer.skip
+```
+
+For example:
+
+```shell
+mvn -pl <module> -Dcheckstyle.skip -Dspotless.check.skip -Denforcer.skip
-Dtest=TestClassName#methodName test
+```
+
+#### Use -am (also-make)
+
+If your target module depends on other modules you've changed locally, prefer
`-am` to rebuild them together in the same reactor.
+Also add `-DfailIfNoTests=false` to avoid failures for modules without tests.
+
+For example:
+
+```shell
+mvn -pl <module> -am -DfailIfNoTests=false -Dtest=TestClassName#methodName test
+```
diff --git a/pom.xml b/pom.xml
index 879f4bcbc0..7d2df173ee 100644
--- a/pom.xml
+++ b/pom.xml
@@ -612,8 +612,7 @@ under the License.
<exclude>**/*.prefs</exclude>
<exclude>**/*.log</exclude>
<!-- Administrative files in the main trunk. -->
- <exclude>**/README.md</exclude>
- <exclude>**/CODE_OF_CONDUCT.md</exclude>
+ <exclude>**/*.md</exclude>
<exclude>.github/**</exclude>
<!-- IDE files. -->
<exclude>**/*.iml</exclude>
