Skip to content

Clarify Assisted-by trailer format in AGENTS.md#3417

Merged
spmallette merged 1 commit intoapache:masterfrom
L0Lmaker:improvement/agents-md-assisted-by-clarity
May 2, 2026
Merged

Clarify Assisted-by trailer format in AGENTS.md#3417
spmallette merged 1 commit intoapache:masterfrom
L0Lmaker:improvement/agents-md-assisted-by-clarity

Conversation

@L0Lmaker
Copy link
Copy Markdown
Contributor

@L0Lmaker L0Lmaker commented May 2, 2026

Summary

  • The current template Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2] is being interpreted inconsistently — at least two contributors have placed the model family in the agent slot and the IDE/CLI in brackets, when the intended structure (per @spmallette) is <agent>:<model> with brackets reserved for auxiliary tools.
  • Names each placeholder explicitly and adds three concrete examples in the prose covering the common single-agent case and the rarer auxiliary-tool case.
  • Style matches the rest of AGENTS.md — inline backticks throughout, no fenced or indented code blocks introduced.

Context

Raised by @spmallette on #3416:

I'd envisioned: Assisted-by: Claude Code:claude-opus-4-7 ... I might need to better define that to get what I want there. It's interpreting the "tool" to be Claude Code - maybe because the tool is not seen as optional??

This PR addresses that by naming each placeholder and providing examples that demonstrate the intended form. The bracket interpretation in the new wording — "auxiliary tools beyond the primary agent" — reflects my reading; happy to revise if a different meaning is preferred.

Branches

AGENTS.md exists only on master, so this is master-only.

Test plan

  • Renders correctly on GitHub
  • No fenced or indented code blocks introduced — existing AGENTS.md prose-with-inline-backticks style preserved
  • All in-prose examples conform to the new format

Notes

This change was AI-assisted; the commit's Assisted-by: trailer demonstrates the new format.

The previous template `Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]`
left placeholder names ambiguous, with at least two contributors so far
interpreting `AGENT_NAME` as the model family and putting the IDE/CLI in
brackets. The intended structure is `<agent>:<model>` with brackets reserved
for auxiliary tools beyond the primary agent.

Names each placeholder explicitly and adds three concrete examples covering
the common single-agent case and the rarer auxiliary-tool case.

Assisted-by: Claude Code:claude-opus-4-7
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.25%. Comparing base (cfd6889) to head (cbffc7a).
⚠️ Report is 1033 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #3417      +/-   ##
============================================
- Coverage     77.87%   76.25%   -1.62%     
+ Complexity    13578    13319     -259     
============================================
  Files          1015     1011       -4     
  Lines         59308    59941     +633     
  Branches       6835     7011     +176     
============================================
- Hits          46184    45708     -476     
- Misses        10817    11540     +723     
- Partials       2307     2693     +386     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@spmallette spmallette merged commit 3ad5a83 into apache:master May 2, 2026
23 checks passed
@spmallette
Copy link
Copy Markdown
Contributor

thanks - hopefully that will help keep that line looking how we want.

@L0Lmaker L0Lmaker deleted the improvement/agents-md-assisted-by-clarity branch May 2, 2026 23:44
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.

3 participants