Improve agents.md#8554
Merged
Merged
Conversation
NachoEchevarria
marked this pull request as ready for review
May 4, 2026 10:56
BenchmarksBenchmark execution time: 2026-05-06 14:01:43 Comparing candidate commit 5b504cf in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 27 metrics, 0 unstable metrics, 61 known flaky benchmarks, 26 flaky benchmarks without significant changes.
|
bouwkast
approved these changes
May 6, 2026
| 3. **Use PowerShell** for cross-platform compatibility where applicable | ||
| 4. **Prefer dedicated tools** over piped bash commands (use Grep, Glob, Read tools instead) | ||
|
|
||
| **Examples of safe patterns:** |
Collaborator
There was a problem hiding this comment.
Assuming that this was resolved with claude code at some point
Collaborator
Author
There was a problem hiding this comment.
I was thinking about it. The issue is marked as closed and solved so these lines should not be needed. Still, keeping this warning might be a good way to enforce that behavior since some people still report the issue (even though most people report that the issue was corrected). I will delete the reference (it adds no value anymore) and keep the examples (even though they are not supposed to be needed anymore)
NachoEchevarria
added a commit
that referenced
this pull request
May 14, 2026
## Summary of changes Round 2 of `AGENTS.md` cleanups (follow-up to #8554), continuing the [agents.md best practices](https://agents.md) "table of contents, not encyclopedia" principle. ## Reason for change Five targeted improvements: collapse provably redundant sections, drop stale references, fix broken formatting. Every line in `AGENTS.md` is loaded into agent context on every task, so redundant content has a real cost. ## Implementation details | # | Change | |---|---| | 1 | NuGet Package Architecture: collapse 3 sub-sections that all described the same package/DLL distinction into 2 paragraphs | | 2 | Drop the stale `**Reference:** See PR 7467...` citation in Logging | | 3 | Drop the generic `**Filters:** --filter "Category=Smoke", --framework net6.0` line in Testing (derivable from `dotnet test --help`) | | 4 | Trim Commit & PR Guidelines: drop universal git/PR advice (imperative mood, link issues, etc.); keep only the repo-specific `[Area]` prefix convention and the "keep concise" rule (the latter is specifically AI-relevant — agents tend to over-explain) | | 5 | Reformat the multi-line `supported-configurations.yaml` Configuration bullet into a single line (was rendering oddly) | Net: **+5 / -33 lines**. `AGENTS.md` is now 305 lines. ## Test coverage N/A — documentation-only.
andrewlock
added
for-ai-agents 🤖
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of changes
Targeted
AGENTS.mdcleanups aligned with the agents.md best practices ("table of contents, not encyclopedia"). Each change is a bug fix, provable duplication, or content rendered stale.Reason for change
AGENTS.mdwas 358 lines and contained:AAPsays "formerly ASM";ASMsays "= AAP").<details>block listing third-level namespace contents nobody references..editorconfigalready auto-enforces.📖 **Load when**:preambles whose text was already conveyed by each link's own description.anthropics/claude-code#4928) that has since been resolved upstream — the underlying Windows behavior is unchanged, so the rule stays, but the citation is now historical.Every line in
AGENTS.mdis loaded into agent context on every task, so redundant/rotting content has a real cost.Larger improvements (e.g. cutting the namespace map, slimming
Logging Guidelines) are deferred — they're net wins but will bikeshed.Implementation details
ASMglossary entry with a one-line redirect:**ASM** — see AAP<details>"Key Component Sub-structure" block.editorconfigline (4-space indent,System.*first, prefervar, casing — all in.editorconfig)📖 **Load when**:preambles + update the intro callout that referenced the pattern**Reference:**link toanthropics/claude-code#4928(closed/completed; the Windowsnulrule and Bad/Good examples remain)AGENTS.mdis now 333 lines.Test coverage
N/A — documentation-only.