Conversation
There was a problem hiding this comment.
Pull request overview
This PR streamlines the always-loaded AI agent guidance by replacing the previous long, highly prescriptive AGENTS.md with a shorter, general-purpose set of repository notes and common commands, and aligns CLAUDE.md accordingly.
Changes:
- Condenses AGENTS.md from a large rule set into a short “project/build/structure/conventions/testing/skills” guide.
- Updates CLAUDE.md to reflect the new guidance source/content.
- Adds focused build/test/conformance command snippets intended for quick agent/operator use.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
CLAUDE.md |
Updated AI context guidance file; currently duplicates AGENTS.md content. |
AGENTS.md |
Rewritten to be concise and general-purpose, with build/test/conformance pointers and key conventions. |
Comments suppressed due to low confidence (1)
CLAUDE.md:3
CLAUDE.mdcurrently duplicates the entire contents ofAGENTS.mdverbatim. This creates two sources of truth to keep in sync; consider makingCLAUDE.mdinclude/referenceAGENTS.md(or otherwise avoid duplication) so future edits only need to happen in one place.
# AGENTS: Development Guidelines for AI Contributors
This file provides guidance to AI coding agents working with code in this repository.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
kpavlov
left a comment
There was a problem hiding this comment.
I agree, that project information was a bit redundant. Everything else is a degradation.
These instructions are now useless and will negatively affect code quality. Let's revert requirements, they are useful and should be loaded on every conversion.
|
@kpavlov Could you please explain in more detail why you are blocking this PR? |
Improve AGENTS.md
Motivation and Context
The previous AGENTS.md contained many elements contradicting best practices.
AGENTS.md/CLAUDE.md is loaded into the context on every request, so a ~300+ line file is too large and fills the context window.
Since the file is loaded on every request, it should be general-purpose rather than targeting specific use cases.
AI coding agents are used not only for writing tests and implementations.
Tests first, always.. This causes the agent to trigger test runs even when not required, increasing request time and token consumption significantly due to large test outputs. For example, on a simple codebase question, the agent ran the full test suite and I waited over 10 minutes for a response.Uphold SOLID principles— self-evident rules, explaining what SOLID stands for is redundant since AI coding agents are already trained on this knowledge.These and other changes follow the best practices.
Types of changes
Checklist
Additional context
https://code.claude.com/docs/en/best-practices
https://resources.anthropic.com/hubfs/The-Complete-Guide-to-Building-Skill-for-Claude.pdf
https://agents.md/#examples