wenjin272 opened a new pull request, #878:
URL: https://github.com/apache/flink-agents/pull/878
<!--
* Thank you very much for contributing to Flink Agents.
* Please add the relevant components in the PR title. E.g., [api],
[runtime], [java], [python], [hotfix], etc.
-->
<!-- Please link the PR to the relevant issue(s). Hotfix doesn't need this.
-->
Linked issue: #877
### Purpose of change
Add AGENTS.md to the flink-agents repo to improve the effectiveness of
coding agents.
* Following OpenAI's best practices, I initialized an `AGENTS.md` file and
manually reviewed its contents.
* This file references a `code_review` document that outlines key
checkpoints for using coding agents in code review tasks. The document was
generated through an iterative process:
* For community pull requests (PRs) that had already undergone manual
review, the coding agent performed a parallel review.
* The results were compared, and the agent was instructed to summarize any
reasonable issues it initially missed. These insights were added to the file.
* After manual adjustments, the agent performed a final review in a clean
context to verify the updated file's effectiveness.
I believe that `AGENTS.md` and `code_review.md` still have significant room
for improvement. However, this is an iterative process rather than a one-time
fix. In subsequent development and code review cycles, the community is
encouraged to adopt these guidelines and refine them continuously.
### Tests
<!-- How is this change verified? -->
No
### API
No
<!-- Does this change touches any public APIs? -->
### Documentation
<!-- Do not remove this section. Check the proper box only. -->
- [ ] `doc-needed` <!-- Your PR changes impact docs -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-included` <!-- Your PR already contains the necessary
documentation updates -->
--
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]
