yzeng1618 commented on code in PR #10411: URL: https://github.com/apache/seatunnel/pull/10411#discussion_r2744386607
########## AGENTS.md: ########## @@ -0,0 +1,238 @@ +# LLM Context Guide for Apache SeaTunnel + +This guide helps AI assistants (LLMs / Agents) make **safe, consistent, and verifiable** changes to the Apache SeaTunnel codebase. It mirrors practices from mature Apache projects and adapts them to SeaTunnel’s **build, testing, architecture, and documentation conventions**. + +## ⚠️ CRITICAL: Validate Before Proposing Changes + +**Agents MUST run verification commands locally before suggesting or finalizing changes.** + +```bash +# Format code (mandatory) +./mvnw spotless:apply + +# Quick verification (mandatory) +./mvnw -q -DskipTests verify + +# Unit tests (strongly recommended) +./mvnw test +``` + +Failure to meet these requirements will likely result in PR rejection. + +## Git Commit Message Convention + +SeaTunnel follows a **strict commit message format** to maintain a clean and searchable history. + +**Format**: + +``` +[Type][Module] Description +``` + +### Types + +* `Feature` – New features +* `Fix` – Bug fixes +* `Improve` – Improvements to existing behavior +* `Docs` – Documentation-only changes +* `Test` – Test cases or test framework changes +* `Chore` – Build, dependency, or maintenance tasks + +### Modules + +* `Connector-V2` – seatunnel-connectors-v2 +* `Zeta` – seatunnel-engine (Zeta engine) +* `Core` – seatunnel-core +* `API` – seatunnel-api +* `Transform-V2` – seatunnel-transforms-v2 +* `Format` – seatunnel-formats +* `Translation` – seatunnel-translation +* `E2E` – seatunnel-e2e + +### Examples + +* `[Fix][Connector-V2] Fix MySQL source split enumeration bug` +* `[Fix][Zeta] Fix checkpoint timeout under heavy backpressure` +* `[Feature][Transform-V2] Add LLM transform plugin` +* `[Improve][Core] Optimize jar package loading speed` +* `[Docs] Update quick start guide` Review Comment: I think we could add DOC doesn't have [Module] to this description, but it’s totally fine to leave it out—this isn’t something we need to overthink. <img width="1355" height="390" alt="image" src="https://github.com/user-attachments/assets/54e8ff09-ad38-49bb-80eb-c237b58f21d8"; /> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
