Add a skill to clarify Java comments - #12362
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
🎯 Code Coverage (details) 🔗 Commit SHA: 104ac01 | Docs | View more details | Give us feedback! |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d87ee17e25
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
The skill cannot run its required Gradle checks because it names a command that this repository does not provide.
🤖 Datadog Autotest · Commit d87ee17 · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest
🟢 Java Benchmark SLOs — All performance SLOs passed
PR vs. master results
Commit: Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion. |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f6d8a8d65e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
One question on the new Given this skill can edit local files, post GitHub review comments, and run |
sarahchen6
left a comment
There was a problem hiding this comment.
I support this skill given more and more AI contributions!
In general, I think the skill is a bit verbose though. I started leaving some comment suggestions, but we should rework to keep instructions minimal so not to overwhelm the context of the AI using this, similar to existing skills like for techdebt: https://github.com/DataDog/dd-trace-java/blob/master/.agents/skills/techdebt/SKILL.md.
WDYT about centering the skill around existing best practices like https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/? I think defining these 9 rules plus a bit of context is sufficient and straightforward.
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Remove scope qualifications made redundant by the skill's shared workflow. Assisted-by: Sisyphus <sisyphus@opencode.ai>
Keep the reference focused on mutation mode, scope, and final validation. Assisted-by: Sisyphus <sisyphus@opencode.ai>
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
|
What Does This Do
Adds the
clarify-java-commentsCodex skill for reviewing or rewriting JavaJavadocs and explanatory comments.
The skill provides source-grounded guidance for:
Tip
At this time, this skill works WAY better with codex.
Motivation
Claude-generated Javadoc and comments often narrate every inference instead of providing useful documentation for human readers. This makes contracts, invariants, and important JVM behavior harder to find and understand.
The skill defines a reusable boundary: retain verified explanations that materially affect the contract, correctness, safe modification, compatibility, or performance
when they are not readily recoverable from nearby code. It should express that reasoning as the shortest useful causal chain and remove the rest.
Additional Notes
authorization boundaries.
Contributor Checklist
type:and (comp:orinst:) labels in addition to any other useful labelsclose,fix, or any linking keywords when referencing an issueUse
solvesinstead, and assign the PR milestone to the issue