Repository navigation
docs: add an agent guide - #186
Merged
Merged
Conversation
Coding agents and new contributors had no single place that states the constraints of this repository (target frameworks, public API snapshots, AOT compatibility, dependency floors) or how to validate a change, so they had to rediscover them from the build files and the pipeline. AGENTS.md keeps the hard rules short, and the deeper references in Docs/agents are read only when needed, outside the published documentation. 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 and the music theme in examples 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: - Never contradicts Mockolate - Feels like core aweXpect - Fast happy path
|
🚀 Benchmark ResultsDetails
|
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
1 participant
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.
Coding agents and new contributors had no single place that states the constraints of this repository (target frameworks, public API snapshots, AOT compatibility, dependency floors) or how to validate a change, so they had to rediscover them from the build files and the pipeline.
AGENTS.md keeps the hard rules short, and the deeper references in Docs/agents are read only when needed, outside the published documentation.
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: