gatorsmile opened a new pull request, #57825:
URL: https://github.com/apache/spark/pull/57825
### What changes were proposed in this pull request?
Extends the "Project Instructions Discovery" section of the root `AGENTS.md`
to cover `CLAUDE.md` as
well as `AGENTS.md`.
The section currently tells agents to look for nested `AGENTS.md` files
only. That wording arrived in
160b6193ee3 (`[MINOR][DOC] Use AGENTS.md for nested project instructions`),
which replaced the
previous `CLAUDE.md` wording. This PR:
- says to check **both** names, and notes that a directory with only a
`CLAUDE.md` still has
instructions that must be read;
- documents the convention this repository already follows at the root
(`AGENTS.md` is the real file,
`CLAUDE.md` is a symlink to it), so a reader knows either name resolves to
the same content and
there is nothing to reconcile;
- states which name to use when adding instructions to a directory that has
neither.
Docs only -- no code, no build files.
### Why are the changes needed?
`CLAUDE.md` is the filename Claude Code discovers by convention, and
contributors add project
instructions under that name. An agent that follows the current instruction
literally looks for
`AGENTS.md` only and skips a directory whose instructions live in a
`CLAUDE.md`. Spelling out the
symlink convention also keeps the two names from drifting into two separate
documents.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
No tests; this changes prose in a markdown file. Verified mechanically:
- Only the real file was edited; the root `CLAUDE.md` symlink is untouched
(`git diff --name-only`
reports `AGENTS.md` alone, and `git ls-files -s` still reports mode
`120000` for `CLAUDE.md`).
- Confirmed the documented root convention: `AGENTS.md` is mode `100644`,
`CLAUDE.md` is `120000`
pointing at `AGENTS.md`.
- New lines stay within the 100-character limit. The one em dash added
matches this file's existing
prose style (already on 20 lines).
### Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Opus 5)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
