[Build] Add AGENTS.md for AI agent coding conventions#4372
Open
shangeyao wants to merge 2 commits into
Open
Conversation
Add AGENTS.md file documenting project architecture, module boundaries, high-sensitivity areas, design patterns, coding conventions (Java/Scala/TypeScript), build commands, PR conventions, AI-generated PR disclosure template, and boundaries for contributors and AI agents.
Co-authored-by: Cursor <cursoragent@cursor.com>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add an
AGENTS.mdfile to the project root, following the same pattern as Apache Iceberg's AGENTS.md. This file serves as agent instructions, documenting:streampark-common,streampark-flink,streampark-spark,streampark-consoleFlinkShimsProxy,FlinkStreaminglifecycle,ConfigKeys, K8s integration, SQL dialect conversion, auth[Module]prefix format, dual database upgrade requirementsWhy
As AI-assisted development becomes more common in open-source projects, having a canonical
AGENTS.mdhelps 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