shangeyao opened a new pull request, #4372: URL: https://github.com/apache/streampark/pull/4372
### What Add an `AGENTS.md` file to the project root, following the same pattern as Apache Iceberg's [AGENTS.md](https://github.com/apache/iceberg/blob/main/AGENTS.md). This file serves as agent instructions, documenting: - **Module Boundaries**: Clear responsibility boundaries for `streampark-common`, `streampark-flink`, `streampark-spark`, `streampark-console` - **High-Sensitivity Areas**: `FlinkShimsProxy`, `FlinkStreaming` lifecycle, `ConfigKeys`, K8s integration, SQL dialect conversion, auth - **Design Patterns**: Lifecycle trait pattern, Shims/Proxy pattern, Service layer separation, implicit enrichment, MyBatis-Plus entity pattern - **Coding Conventions**: Java (Spotless/Checkstyle/JUnit 5), Scala (Scalafmt/ScalaTest), TypeScript/Vue (ESLint/Prettier) - **Commands**: Build, test, format, lint commands for all layers - **PR & Commit Conventions**: `[Module]` prefix format, dual database upgrade requirements - **AI-Generated PR Disclosure**: Standardized template following ASF generative tooling guidelines - **Boundaries**: "Never" and "Ask first" rules for contributors and AI agents ### Why As AI-assisted development becomes more common in open-source projects, having a canonical `AGENTS.md` helps both human contributors and AI tools understand the project's unique conventions, sensitive areas, and boundaries. This reduces review burden and improves contribution quality. ### Related Issue Closes #4370 --- **AI Disclosure** - Model: DeepSeek-V4-Pro - Platform/Tool: TRAE IDE - Human Oversight: unreviewed - Prompt Summary: Generate AGENTS.md for StreamPark project based on the project's actual conventions, codebase structure, and the Apache Iceberg AGENTS.md reference format -- 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]
