Skip to content

docs: add build & test guidance for coding agents to AGENTS.md#6722

Merged
milamberspace merged 2 commits into
apache:masterfrom
milamberspace:jmeter-agents-build-notes
Jul 8, 2026
Merged

docs: add build & test guidance for coding agents to AGENTS.md#6722
milamberspace merged 2 commits into
apache:masterfrom
milamberspace:jmeter-agents-build-notes

Conversation

@milamberspace

Copy link
Copy Markdown
Contributor

Summary

Adds a short "Building and testing" section to AGENTS.md so any AI coding
agent has JMeter's build context up front — how to build and test, how to
format before handing a change back, and how to select a JDK for tests.

Kept deliberately minimal: only JMeter-specific, non-obvious guidance (agents
already know generic Gradle commands). It covers:

  • use ./gradlew --quiet … to reduce output; run ./gradlew --quiet classes style
    and fix any issues before reporting a change as done;
  • select the test JDK with -PjdkTestVersion / -PjdkTestVendor
    (jdkTestVersion is enough for most cases);
  • list every build parameter with ./gradlew parameters.

Pure documentation — no code or build changes; it points at the existing
gradle.md / README.md build docs rather than duplicating them.

Reviewed on a fork PR by Vladimir Sitnikov (vlsi), who trimmed the wording to
"only what an agent doesn't already know" and noted it looked mergeable for
apache/jmeter.

Document the JMeter build/test essentials so any coding agent knows how to
build, run, and test the project — independent of any agent framework:

- core gradlew tasks (build, test, check, runGui, createDist, style)
- JDK selection for build and tests via -PjdkBuildVersion /
  -PjdkTestVersion / -PjdkTestVendor (the test-JDK flag), with an example
- dependency-checksum refresh, coverage, and RAT tasks
- pointer to the CI matrix and the Error Prone job

Addresses the dev@ suggestion to give agents JMeter-specific build context
(e.g. how to trigger tests under a specific JDK version).

Generated-by: Claude Opus 4.8
Apply @vlsi's review on PR #2: keep only JMeter-specific, non-obvious
guidance an agent doesn't already know — the --quiet flag, the
"run ./gradlew --quiet classes style before handing back" instruction,
and the JDK-test build parameters. Drop the generic gradlew build/test/check
list, the heading suffix, and the checksums/coverage/RAT/CI section.

Generated-by: Claude Opus 4.8

@vlsi vlsi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good. Please squash the commits when merging

@milamberspace milamberspace merged commit f3c6d5c into apache:master Jul 8, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants