Skip to content

docs: make agent guide wording generic#9142

Merged
jdx merged 1 commit intomainfrom
codex/agent-neutral-instructions
Apr 16, 2026
Merged

docs: make agent guide wording generic#9142
jdx merged 1 commit intomainfrom
codex/agent-neutral-instructions

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented Apr 16, 2026

Summary

  • retitle the shared agent instructions away from CLAUDE.md-specific wording
  • describe the file as guidance for AI coding agents while noting the compatibility filename and AGENTS.md symlink
  • make the GitHub AI-generated comment example agent-neutral

Validation

  • mise run format

Note

Low Risk
Documentation-only wording changes with no impact to runtime behavior or developer workflows beyond clarified guidance.

Overview
Retitles CLAUDE.md from a Claude-specific guide to a generic Repository Agent Guide, and updates the intro to describe it as instructions for any AI coding agent while noting the compatibility filename and AGENTS.md symlink.

Tweaks the GitHub interaction guidance to use agent-neutral wording for the required AI-generated disclosure message.

Reviewed by Cursor Bugbot for commit 078714e. Bugbot is set up for automated code reviews on this repo. Configure here.

@jdx jdx marked this pull request as ready for review April 16, 2026 12:48
@jdx jdx merged commit 13929e0 into main Apr 16, 2026
26 of 27 checks passed
@jdx jdx deleted the codex/agent-neutral-instructions branch April 16, 2026 12:48
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 16, 2026

Greptile Summary

This PR renames the CLAUDE.md heading from # CLAUDE.md to # Repository Agent Guide and updates the intro sentence and GitHub-comment example to use agent-neutral language, while noting the compatibility filename and the AGENTS.md symlink. The changes are documentation-only with no impact on runtime behavior.

Confidence Score: 5/5

Safe to merge — documentation-only wording changes with no runtime impact.

All three edits are cosmetic/documentation changes. No code, configuration, or logic is altered. No P0/P1 findings.

No files require special attention.

Important Files Changed

Filename Overview
CLAUDE.md Title updated to "Repository Agent Guide" and intro/GitHub example reworded to be agent-neutral; no logic changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[AI Coding Agent] --> B{Which agent?}
    B -->|Claude Code| C[reads CLAUDE.md]
    B -->|Other agents| D[reads AGENTS.md symlink]
    C --> E[Repository Agent Guide]
    D --> E
Loading

Reviews (1): Last reviewed commit: "docs: make agent guide wording generic" | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates CLAUDE.md to generalize the terminology from 'Claude Code' to 'AI coding agents', including a title change and updated guidance for GitHub interactions. A review comment suggests replacing 'assistant' with 'agent' in the disclaimer example to ensure consistency with the rest of the document's updated nomenclature.

Comment thread CLAUDE.md
## GitHub Interactions

When posting comments on GitHub PRs or discussions, always include a note that the comment was AI-generated (e.g., "*This comment was generated by Claude Code.*").
When posting comments on GitHub PRs or discussions, always include a note that the comment was AI-generated (e.g., "*This comment was generated by an AI coding assistant.*").
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.

medium

For consistency with the rest of the document (including the new title and the introductory paragraph), consider using the term "agent" instead of "assistant" in the example comment. This aligns with the PR's goal of making the wording generic while maintaining internal terminology consistency.

Suggested change
When posting comments on GitHub PRs or discussions, always include a note that the comment was AI-generated (e.g., "*This comment was generated by an AI coding assistant.*").
When posting comments on GitHub PRs or discussions, always include a note that the comment was AI-generated (e.g., "*This comment was generated by an AI coding agent.*").

@github-actions
Copy link
Copy Markdown

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.14 x -- echo 22.3 ± 0.8 21.3 28.1 1.00
mise x -- echo 22.7 ± 0.5 21.9 25.6 1.02 ± 0.04

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.14 env 21.6 ± 0.6 20.9 27.8 1.00
mise env 22.5 ± 0.7 21.4 25.5 1.04 ± 0.04

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.14 hook-env 22.3 ± 0.4 21.5 24.1 1.00
mise hook-env 22.9 ± 0.6 22.0 27.9 1.03 ± 0.03

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.14 ls 19.9 ± 0.7 19.1 29.1 1.00
mise ls 20.1 ± 0.4 19.4 21.7 1.01 ± 0.04

xtasks/test/perf

Command mise-2026.4.14 mise Variance
install (cached) 146ms 147ms +0%
ls (cached) 77ms 77ms +0%
bin-paths (cached) 81ms 81ms +0%
task-ls (cached) 824ms 791ms +4%

mise-en-dev added a commit that referenced this pull request Apr 17, 2026
### 🚀 Features

- **(registry)** add .perl-version support for perl by @ergofriend in
[#9102](#9102)
- **(task)** add Tera template support for inline table run tasks by
@iamkroot in [#9079](#9079)

### 🐛 Bug Fixes

- **(env)** use runtime symlink paths for fuzzy versions by @jdx in
[#9143](#9143)
- **(github)** use full token resolution chain for attestation
verification by @jdx in [#9154](#9154)
- **(go)** Remove install-time version override for subpath packages by
@c22 in [#9135](#9135)
- **(npm)** respect install_before when resolving dist-tag versions by
@webkaz in [#9145](#9145)
- **(self-update)** ensure subcommand exists by @salim-b in
[#9144](#9144)
- **(task)** show available tasks when run target missing by @jdx in
[#9141](#9141)
- **(task)** forward task help args and add raw_args by @jdx in
[#9118](#9118)
- **(task)** remove red/yellow from task prefix colors by
@lechuckcaptain in [#8782](#8782)
- **(task)** merge TOML task block into same-named file task and surface
resolved dir by @jdx in [#9147](#9147)
- **(toolset)** round-trip serialized tool options by @atharvasingh7007
in [#9124](#9124)
- **(vfox)** fallback to absolute bin path if env_keys not set by
@80avin in [#9151](#9151)

### 📚 Documentation

- make agent guide wording generic by @jdx in
[#9142](#9142)

### 📦️ Dependency Updates

- update ghcr.io/jdx/mise:deb docker digest to e019cb9 by @renovate[bot]
in [#9160](#9160)
- update ghcr.io/jdx/mise:copr docker digest to 8d25608 by
@renovate[bot] in [#9159](#9159)
- update ghcr.io/jdx/mise:rpm docker digest to 22e52da by @renovate[bot]
in [#9161](#9161)
- update ghcr.io/jdx/mise:alpine docker digest to a3da97c by
@renovate[bot] in [#9158](#9158)
- update rust docker digest to 4a2ef38 by @renovate[bot] in
[#9162](#9162)
- update ubuntu:24.04 docker digest to c4a8d55 by @renovate[bot] in
[#9164](#9164)
- update rust crate aws-lc-rs to v1.16.3 by @renovate[bot] in
[#9165](#9165)
- update ubuntu docker tag to resolute-20260413 by @renovate[bot] in
[#9169](#9169)
- update rust crate clap to v4.6.1 by @renovate[bot] in
[#9166](#9166)
- update taiki-e/install-action digest to a2352fc by @renovate[bot] in
[#9163](#9163)
- update rust crate ctor to 0.10 by @renovate[bot] in
[#9170](#9170)
- update rust crate tokio to v1.52.1 by @renovate[bot] in
[#9167](#9167)
- update rust crate rmcp-macros to 0.17 by @renovate[bot] in
[#9173](#9173)
- update rust crate signal-hook to 0.4 by @renovate[bot] in
[#9177](#9177)
- update rust crate zipsign-api to 0.2 by @renovate[bot] in
[#9180](#9180)
- update rust crate toml_edit to 0.25 by @renovate[bot] in
[#9179](#9179)
- update rust crate strum to 0.28 by @renovate[bot] in
[#9178](#9178)

### 📦 Registry

- add ibmcloud by @dnwe in
[#9139](#9139)
- add rush by @jdx in [#9146](#9146)

### New Contributors

- @80avin made their first contribution in
[#9151](#9151)
- @atharvasingh7007 made their first contribution in
[#9124](#9124)
- @lechuckcaptain made their first contribution in
[#8782](#8782)
- @ergofriend made their first contribution in
[#9102](#9102)
- @dnwe made their first contribution in
[#9139](#9139)

## 📦 Aqua Registry Updates

#### New Packages (3)

-
[`controlplaneio-fluxcd/flux-operator`](https://github.com/controlplaneio-fluxcd/flux-operator)
-
[`dependency-check/DependencyCheck`](https://github.com/dependency-check/DependencyCheck)
- [`kiro.dev/kiro-cli`](https://github.com/kiro.dev/kiro-cli)

#### Updated Packages (2)

-
[`jreleaser/jreleaser/standalone`](https://github.com/jreleaser/jreleaser/standalone)
- [`sigstore/cosign`](https://github.com/sigstore/cosign)
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.

1 participant