CLAUDE.md and the Copilot instructions had drifted from the code (old API names, a removed attribute, a missing solution file) and each served only one tool. A single AGENTS.md with the hard constraints, plus deeper reference docs read on demand, gives every agent and contributor one verified source to keep current.
Docs/agents/design-goals.md gives every change the same priorities. Correctness is a must; the other goals are strong defaults and win in this order when they conflict:
- Stable and compatible
- AOT and trimming friendly
- A consistent, discoverable and pleasant API
- Fast, especially on the happy path
- Extensible
- Errors at compile time rather than at run time
- Documented and pleasant to read, using Docusaurus features where they help
It also sets the code rules (modern C# within the target frameworks, async rules including ConfigureAwait(false), patterns to avoid), the checks before a commit (including no new Sonar findings and asking before suppressing one), and how to handle review findings.
Goals of this repository:
- Every mockable shape compiles and behaves
- One entry point and one verb surface
- Consistent vocabulary
- Allocation-free hot path
- Invisible generated code
- AOT by construction, within the Roslyn floor
- Correct incremental caching
CLAUDE.md and the Copilot instructions had drifted from the code (old API names, a removed attribute, a missing solution file) and each served only one tool. A single AGENTS.md with the hard constraints, plus deeper reference docs read on demand, gives every agent and contributor one verified source to keep current.
Docs/agents/design-goals.md gives every change the same priorities. Correctness is a must; the other goals are strong defaults and win in this order when they conflict:
It also sets the code rules (modern C# within the target frameworks, async rules including ConfigureAwait(false), patterns to avoid), the checks before a commit (including no new Sonar findings and asking before suppressing one), and how to handle review findings.
Goals of this repository: