Align AGENTS.md instructions with rest of guidance in the repo - #9826
Conversation
Merging this PR will improve performance by ×2.7
|
| Mode | Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|---|
| ⚡ | WallTime | words_gather_dispatch_avx2[1024] |
46 ns | 17 ns | ×2.7 |
Tip
Curious why performance improved? Comment @codspeedbot explain why performance improved on this PR, or directly use the CodSpeed MCP with your agent.
Comparing claude/agents-doc-audit-nop7x7 (956777b) with develop (a13c246)2
Footnotes
-
218 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
-
No successful run was found on
develop(9fdaa38) during the generation of this report, so a13c246 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
e9c3b6d to
2f2ea33
Compare
The agent instruction files had accumulated three kinds of redundancy: checks subsumed by other checks, guidance restated across AGENTS.md, STYLE.md and the skills, and prescribed commands that did not match what CI runs. Correct the check commands so a local pass predicts CI: - Add `-D warnings` to clippy. Without it clippy exits successfully on exactly the warnings CI rejects. - Point fmt at the nightly pinned as NIGHTLY_TOOLCHAIN rather than a floating `+nightly`, which can format differently from the toolchain CI checks against. - Scope the Rust checks with `-p <crate>` instead of running them workspace-wide over 68 crates, which is CI's job. - Use `uvx` for ruff in the Python bindings, matching CI's invocation. Drop subsumed checks: - `cargo build`, already performed by `cargo nextest run` and `cargo clippy --all-targets`, and repeated under a third profile. - The clang-format `--dry-run --Werror` pass over files just formatted in place. - `python -m py_compile`, whose errors are already reported by ruff, basedpyright and pytest collection. - The per-crate `cargo fmt --check` in vortex-python/AGENTS.md, which now defers to the root file and so picks up clippy as well. Remove duplicated prose: the CI Investigation section (contained in the ci-failure-analysis skill it routes to), the Performance section and the hidden-cost accessor bullet (both paraphrases of the STYLE.md table, now a single pointer), the yamllint and Rust-checks-for-docs rules that nested AGENTS.md files already own, and five of the eight Common Mistakes bullets that restated rules stated earlier in the same file. Delete the query skill. Its crate map had already drifted from the Repository Layout section it duplicated, omitting vortex-cloud and vortex-io. Document three CI checks no agent file mentioned, all of which fail on new files rather than edited ones: REUSE SPDX headers, typos, and the assertion that the tree is clean after a build. Signed-off-by: Robert Kruszewski <github@robertk.io> Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Vm8WdEPBCw9hfWivTiuDp1 Signed-off-by: Robert Kruszewski <github@robertk.io>
4371247 to
956777b
Compare
| @@ -1,36 +0,0 @@ | |||
| --- | |||
4 participants
Deduplicate agents.md with other guidance in the repo (i.e. style.md and ci checks) remove the query ski