[FLINK-39881] Add AGENTS.md and generative AI tooling disclosure to PR template#1133
Open
spuru9 wants to merge 2 commits into
Open
[FLINK-39881] Add AGENTS.md and generative AI tooling disclosure to PR template#1133spuru9 wants to merge 2 commits into
spuru9 wants to merge 2 commits into
Conversation
Contributor
Author
|
cc: @Dennis-Mircea @gyfora PTAL! |
Dennis-Mircea
left a comment
Contributor
There was a problem hiding this comment.
The change looks good on its own. One thing worth noting: the Flink core project pairs this with an AGENTS.md file.
Either way, I'd defer to the PMC level on the timing and rollout.
Contributor
Author
|
@1996fanrui @gyfora Can you take a look at this, Thanks. |
Contributor
Author
|
Also added a root AGENTS.md (adapted from apache/flink) and restored the template's "See AGENTS.md" reference now that the file exists; updated the title/description to match. |
Add a root AGENTS.md providing guidance for AI coding agents working with the Flink Kubernetes Operator codebase (prerequisites, commands, repository structure, the operator/observer/reconciler architecture, common change patterns, coding/testing standards, and contribution boundaries). Restore the 'See AGENTS.md for the full guidance' reference in the PR template's generative-AI section, now that the file exists. Generated-by: Claude Code (Claude Opus 4.8)
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
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
This pull request adopts the Apache Flink AI-assisted contribution guidelines for the Flink Kubernetes Operator repository. It does two things:
apache/flink.AGENTS.mdproviding guidance for AI coding agents working with this codebase, modeled onapache/flink'sAGENTS.mdand adapted to the operator.This is a follow-up to FLINK-39477, which adopted AI-assisted contribution guidelines for the main Flink repository. That ticket was closed with a note that other Flink-project owned repositories should create related follow-ups — this PR is the follow-up for the Kubernetes Operator.
Brief change log
.github/PULL_REQUEST_TEMPLATE.md, including the disclosure checkbox, theGenerated-by:line, and a link to the ASF Generative Tooling Guidance.AGENTS.mdcovering prerequisites, build/test commands, repository structure, the operator/observer/reconciler architecture, common change patterns, coding/testing standards, and contribution boundaries — adapted fromapache/flink'sAGENTS.mdfor this repository (Java 17, plainmvn, no Scala, CRDs as the public API surface).AGENTS.mdfrom the PR template's generative-AI section ("See AGENTS.md for the full guidance"), matchingapache/flink's wording now that the file exists.Verifying this change
This change is a trivial rework / code cleanup without any test coverage (PR-template / documentation only).
Does this pull request potentially affect one of the following parts:
CustomResourceDescriptors: noDocumentation
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Claude Opus 4.8)