Repository navigation
Conversation
🟢 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. |
sarahchen6
left a comment
There was a problem hiding this comment.
A few small suggestions, but otherwise looks good! I didn't approve, as this PR is still in draft mode. I support the gradle-best-practices recommendations though 👍
| Use `gradle-best-practices` before changing Gradle code here. If it is missing or incomplete, | ||
| follow the [skill setup](../docs/how_to_work_with_gradle.md#gradle-skills) before editing. |
There was a problem hiding this comment.
nit: with the addition in the root AGENTS.md, this and the similar lines in buildSrc/AGENTS.md shouldn't be necessary
There was a problem hiding this comment.
I'd rather have it in the two places, precisely because they're in two distinct folders. That way an agent working only in buildSrc can see the link to the gradle doc.
Also, I'd rather avoid adding it to the root AGENTS.md, as it's somewhat specific to gradle folder. And this reinforce the intent for the AGENT there: read this doc, AI!.
| New project-facing conventions usually belong in `build-logic`. This folder still holds | ||
| plugins and shared types that need the `buildSrc` classloader. Keep changes to existing | ||
| plugins where they are unless the task includes moving them. |
There was a problem hiding this comment.
This could be put in the how_to_work_with_gradle.md doc? I think it's mostly covered in the table under the What are Gradle Files? section
There was a problem hiding this comment.
I wanted to reinforce this for humans as well. But you're right maybe I can just point to the right doc section.
| This guide covers Gradle practices and how they apply in this repository, including where | ||
| our current build cannot yet follow a best practice. The project-specific sections explain | ||
| conventions used across the build. | ||
|
|
||
| Update this guide when a change affects that shared advice. Keep implementation notes, | ||
| workarounds and procedures for a single plugin or task with its source or local documentation. |
There was a problem hiding this comment.
nit: simplify to
| This guide covers Gradle practices and how they apply in this repository, including where | |
| our current build cannot yet follow a best practice. The project-specific sections explain | |
| conventions used across the build. | |
| Update this guide when a change affects that shared advice. Keep implementation notes, | |
| workarounds and procedures for a single plugin or task with its source or local documentation. | |
| This guide covers shared Gradle practices, repository conventions, and current exceptions. Update it when shared guidance changes; keep guidance specific to one plugin or task beside its source or local documentation. |
| ### Codex | ||
|
|
||
| Ask the built-in [skill installer](https://learn.chatgpt.com/docs/build-skills#install-curated-skills-for-local-use) | ||
| to install the skill from Gradle's repository: | ||
|
|
||
| ```text | ||
| $skill-installer install https://github.com/gradle/gradle-skills/tree/main/skills/gradle-best-practices | ||
| ``` | ||
|
|
||
| Then invoke it with `$gradle-best-practices`. If it does not appear after installation, | ||
| restart the session. | ||
|
|
||
| ### Claude Code | ||
|
|
||
| Install Gradle's plugin: | ||
|
|
||
| ```text | ||
| /plugin marketplace add gradle/gradle-skills | ||
| /plugin install gradle-skills@gradle-skills | ||
| ``` | ||
|
|
||
| Invoke the skill with `/gradle-skills:gradle-best-practices`. Each contributor installs the | ||
| plugin for their own setup; naming it in repository instructions does not fetch it. | ||
| See the [upstream installation guide](https://github.com/gradle/gradle-skills#installation) | ||
| for other agents and installation options. | ||
|
|
There was a problem hiding this comment.
we probably don't need to list these instructions ourselves since it's already included in the skill's README? and the agent should already go through that
What Does This Do
Add folder-specific agent instructions for
buildSrcandbuild-logic, with small Claude Code imports. Keep the shared Gradle advice, skill installation steps and guidance on updating the guide indocs/how_to_work_with_gradle.md.Motivation
Explain general practices once, and let the folder instructions focus on local constraints. The Gradle guide now covers plugin independence, task dependencies and cache checks alongside the existing advice.
Additional Notes
Contributors install the required skill using the steps in the guide. The provider example was run in an isolated build, including configuration-cache reuse. Repository tests and live Codex/Claude instruction-loading sessions were not run.
Tip
Claude Code v2.1.277+ supports
AGENTS.mdnatively, but its default prefersCLAUDE.mdwhen one exists on the project path, see Claude Code instruction loading.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