Add AI Agent coding guide (AGENTS.md & AGENTS.zh-CN.md)#27968
Closed
fightBoxing wants to merge 1 commit intoapache:masterfrom
Closed
Add AI Agent coding guide (AGENTS.md & AGENTS.zh-CN.md)#27968fightBoxing wants to merge 1 commit intoapache:masterfrom
fightBoxing wants to merge 1 commit intoapache:masterfrom
Conversation
Add AGENTS.md (English) and AGENTS.zh-CN.md (Chinese) which provide comprehensive coding guidelines for AI agents contributing to Flink. The guide covers: - Critical rules (forbidden imports, required utility classes, Java version) - API stability and design patterns - Code organization and module structure - Error handling and concurrency - Testing standards (AssertJ mandatory) - Dependencies and shading - Build & CI conventions - Git & Pull Request workflow - AI Agent behavioral boundaries
Collaborator
Contributor
|
@fightBoxing A PR for introducing Agents in already in discussion #27776 |
Contributor
|
Superseded by #27776 - Also https://flink.apache.org/how-to-contribute/contribute-code/#ai-assisted-contributions is applicable here. |
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
4 participants
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.
Summary
AGENTS.md(English): comprehensive AI agent coding guide for Apache Flink contributorsAGENTS.zh-CN.md(Chinese): Chinese translation of the same guideThe guide covers 13 sections:
Motivation
As AI coding agents become more common contributors to open-source projects, having a dedicated
AGENTS.mdguide helps agents understand project-specific conventions, architectural patterns, and quality standards enforced by Checkstyle, Spotless, ArchUnit, and RAT.Test Plan
tools/maven/checkstyle.xml), Spotless config, and architecture tests (flink-architecture-tests/)