Aspire
AGENTS.md632 starsChanged 4 days agoMITView on GitHub
This repository contains independently shipped Aspire integrations and extensions. Most changes should stay within one integration and its matching tests, examples, and README. Follow applicable path-specific guidance in .github/instructions/. Keep generated */api/*.cs files unchanged unless the task explicitly requires API baseline regeneration. Use .github/copilot-instructions.md for the repository-wide Copilot baseline and docs/create-integration.md when adding an integration.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository7 other files it gives its agents.
- .github/copilot-instructions.mdCopilot instructions
- aspire-typescript-apphostSkill
- aspire-upgradeSkill
- client-integration-authoringSkill
- dotnet-inspectSkill
- hosting-integration-authoringSkill
- playwright-cliSkill
The file
We split this AGENTS.md into the rules it gives an agent
6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 18
Read its adjacent tests, example, and README.
- Very specific: line 20
Use the relevant skill under .agents/skills/ for specialized workflows.
- Distinctive: line 21
Run the narrowest build or test command that proves the change.
- Very specific: line 23
Follow applicable path-specific guidance in .github/instructions/.
- Distinctive: line 32
Prefer focused changes and do not refactor unrelated integrations.
- Very specific: line 34
Use .github/copilot-instructions.md for the repository-wide Copilot baseline and docs/create-integration.md when adding an integration.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
CommunityToolkit Aspire contributor guidance
This repository contains independently shipped Aspire integrations and extensions. Most changes should stay within one integration and its matching tests, examples, and README.
Repository map
src/contains shipping packages.- Hosting packages use
CommunityToolkit.Aspire.Hosting.*. - Client packages use
CommunityToolkit.Aspire.*.
- Hosting packages use
tests/contains the matching xUnit projects.examples/contains minimal AppHosts and consumer examples.docs/contains contributor and maintenance documentation.eng/contains repository automation.
Working in this repository
- Identify the integration under change.
- Read its adjacent tests, example, and README.
- Compare with one or two nearby integrations that use the same pattern.
- Use the relevant skill under
.agents/skills/for specialized workflows. - Run the narrowest build or test command that proves the change.
Follow applicable path-specific guidance in .github/instructions/. Keep generated */api/*.cs files unchanged unless the task explicitly requires API baseline regeneration.
Core conventions
- Hosting extension methods use the
Aspire.Hostingnamespace. - Client extension methods use the
Microsoft.Extensions.Hostingnamespace. - Hosting resource types normally use
Aspire.Hosting.ApplicationModel. - Public APIs require XML documentation.
- The repository treats warnings as errors.
- Prefer focused changes and do not refactor unrelated integrations.
Use .github/copilot-instructions.md for the repository-wide Copilot baseline and docs/create-integration.md when adding an integration.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.