Skip to content

Document method comment style - #12338

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 3 commits into
masterfrom
matthew.li/agents-javadoc-comments
Sep 2, 2026
Merged

Document method comment style#12338
gh-worker-dd-mergequeue-cf854d[bot] merged 3 commits into
masterfrom
matthew.li/agents-javadoc-comments

Conversation

@mhlidd

@mhlidd mhlidd commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

What Does This Do

Adds an agent code convention requiring concise Javadoc comments for class, method, and field documentation. The rule uses positive, active wording.

Motivation

Keeps declaration-level documentation discoverable through Java tooling and gives coding agents direct guidance without relying on negative phrasing.

Additional Notes

This is an instruction-only change with no runtime impact. The latest update addresses review feedback by replacing the previous never wording with an active instruction.

Validation:

  • git diff --check
  • Repository pre-commit checks, including Spotless and CodeNarc

Contributor Checklist

Jira ticket: N/A

@mhlidd mhlidd added type: documentation comp: tooling Build & Tooling tag: ai generated Largely based on code generated by an AI or LLM labels Aug 28, 2026
@mhlidd
mhlidd marked this pull request as ready for review August 28, 2026 21:46
@mhlidd
mhlidd requested a review from a team as a code owner August 28, 2026 21:46
@mhlidd
mhlidd requested review from ygree and removed request for a team August 28, 2026 21:46

@datadog-datadog-prod-us1 datadog-datadog-prod-us1 Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Datadog Autotest: PASS

More details

The new rule applies only to agent instructions. It does not change runtime code.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Datadog Autotest · Commit cbc899f · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest

@dd-octo-sts

dd-octo-sts Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

🟢 Java Benchmark SLOs — All performance SLOs passed

Suite Status
Startup 🟢 pass

SLO thresholds are defined here based on automatically generated metrics. A warning is raised when results are within 5% of the threshold.

PR vs. master results
Scenario Candidate master Δ (95% CI of mean)
startup:insecure-bank:iast:Agent 14.87 s 14.70 s [+0.3%; +2.0%] (maybe worse)
startup:insecure-bank:tracing:Agent 13.63 s 13.70 s [-1.4%; +0.4%] (no difference)
startup:petclinic:appsec:Agent 17.62 s 17.28 s [+1.0%; +2.9%] (significantly worse)
startup:petclinic:iast:Agent 17.44 s 17.57 s [-1.5%; +0.0%] (no difference)
startup:petclinic:profiling:Agent 17.44 s 17.49 s [-1.3%; +0.7%] (no difference)
startup:petclinic:sca:Agent 17.52 s 17.47 s [-0.8%; +1.5%] (no difference)
startup:petclinic:tracing:Agent 16.57 s 16.68 s [-1.7%; +0.5%] (no difference)

Commit: 785c0d83 · CI Pipeline · Benchmarking Platform UI


Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion.

Comment thread AGENTS.md Outdated
@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 58.83% (-0.04%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 785c0d8 | Docs | View more details | Give us feedback!

@mhlidd
mhlidd force-pushed the matthew.li/agents-javadoc-comments branch from 684a95d to 785c0d8 Compare August 31, 2026 16:31
@mhlidd
mhlidd added this pull request to the merge queue Sep 2, 2026
@dd-octo-sts

dd-octo-sts Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

/merge

@gh-worker-devflow-routing-ef8351

gh-worker-devflow-routing-ef8351 Bot commented Sep 2, 2026

Copy link
Copy Markdown

View all feedbacks in Devflow UI.

2026-09-02 17:15:23 UTC ℹ️ Start processing command /merge


2026-09-02 17:15:31 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 1h (p90).


2026-09-02 17:29:59 UTCMergeQueue: The build pipeline contains failing jobs for this merge request

Build pipeline has failing jobs for 2c67cb3:

⚠️ Do NOT retry failed jobs directly (why?).

What to do next?

  • Investigate the failures and when ready, re-add your pull request to the queue!
  • If your PR checks are green, try to rebase/merge. It might be because the CI run is a bit old.
  • Any question, go check the FAQ.
Details

Since those jobs are not marked as being allowed to fail, the pipeline will most likely fail.
Therefore, and to allow other builds to be processed, this merge request has been rejected and the pipeline got canceled.

@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 2, 2026
@mhlidd
mhlidd added this pull request to the merge queue Sep 2, 2026
@dd-octo-sts

dd-octo-sts Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

/merge

@gh-worker-devflow-routing-ef8351

gh-worker-devflow-routing-ef8351 Bot commented Sep 2, 2026

Copy link
Copy Markdown

View all feedbacks in Devflow UI.

2026-09-02 18:46:31 UTC ℹ️ Start processing command /merge


2026-09-02 18:46:36 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 1h (p90).


2026-09-02 19:37:57 UTC ℹ️ MergeQueue: This merge request was merged

@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 2, 2026
@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot merged commit a1b6599 into master Sep 2, 2026
602 checks passed
@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot deleted the matthew.li/agents-javadoc-comments branch September 2, 2026 19:37
@github-actions github-actions Bot added this to the 1.66.0 milestone Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp: tooling Build & Tooling tag: ai generated Largely based on code generated by an AI or LLM type: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants