[FLINK-XXXXX][docs] Add AGENTS.md and AI disclosure to PR template#27776
Draft
MartijnVisser wants to merge 1 commit intoapache:masterfrom
Draft
[FLINK-XXXXX][docs] Add AGENTS.md and AI disclosure to PR template#27776MartijnVisser wants to merge 1 commit intoapache:masterfrom
MartijnVisser wants to merge 1 commit intoapache:masterfrom
Conversation
Collaborator
Add AGENTS.md with guidelines for AI coding agents: prerequisites, build/test commands, repository structure, architecture boundaries, common change patterns, coding standards, testing standards, commit conventions, and boundaries. Add AI-assisted contribution disclosure checkbox to the PR template, linking to ASF Generative Tooling Guidance. Generated-by: Claude Code 1.0.33 (Claude Opus 4.6, 1M context)
MartijnVisser
force-pushed
the
agents.md
branch
from
9d4bd36 to
61e65e7
Compare
snuyanzin
reviewed
Mar 20, 2026
| - Edit generated files by hand when a generation workflow exists | ||
| - Use the legacy `SourceFunction` or `SinkFunction` interfaces for connectors; use the `Source` API (FLIP-27) and `SinkV2` API instead | ||
| - Add `Co-Authored-By` with an AI agent as co-author in commit messages; AI agents are assistants, not authors. Use `Generated-by: <Tool Name and Version>` instead. | ||
| - Use destructive git operations unless explicitly requested |
Contributor
There was a problem hiding this comment.
may be also add
do not use CHECKSTYLE:ON/CHEKSTYLE:OFF unless explicitly requested
same for @SuppressWarning
snuyanzin
reviewed
Mar 20, 2026
|
|
||
| ### Adding a new table operator (e.g., join type, aggregate) | ||
|
|
||
| 1. **Planner rule** in `flink-table-planner` under `plan/rules/physical/stream/` (match conditions, transform to physical node) |
Contributor
There was a problem hiding this comment.
do not write new rule in scala
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
3 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.
What is the purpose of the change
Make the Flink codebase accessible to AI coding agents and establish lightweight guidelines for AI-assisted contributions.
Brief change log
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (yes / no)Documentation
Was generative AI tooling used to co-author this PR?