agentleFS
CommunityToolkitCommunityToolkit/Aspire/.github/copilot-instructions.md

Aspire

Copilot instructions632 starsChanged 4 days agoMITView on GitHub

This repository contains community-maintained Aspire integrations and extensions. Shipping packages are under src/, matching xUnit projects are under tests/, and minimal usage examples are under examples/.

The file

We split this copilot-instructions.md into the rules it gives an agent

9 rules. About 0 are common, 5 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Use file-scoped namespaces and the repository's existing formatting.

    line 11
  2. Distinctive:

    All public APIs require XML documentation.

    line 12
  3. Very specific:

    Prefer is null and is not null over equality checks with null.

    line 14
  4. Very specific:

    Do not manually edit generated */api/*.cs files unless API baseline regeneration is explicitly required.

    line 15
  5. Distinctive:

    Start with the integration being changed, then inspect its tests, example, README, and one or two same-pattern integrations.

    line 19
  6. Very specific:

    Use the applicable files under .github/instructions/ for path-specific guidance.

    line 20
  7. Very specific:

    Use focused workflows under .agents/skills/ for specialized tasks.

    line 21
  8. Distinctive:

    Keep changes scoped to the requested integration and avoid unrelated refactoring.

    line 22
  9. Distinctive:

    Run the narrowest relevant build or test command.

    line 23

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

Aspire Community Toolkit

This repository contains community-maintained Aspire integrations and extensions. Shipping packages are under src/, matching xUnit projects are under tests/, and minimal usage examples are under examples/.

Package and API conventions

  • Hosting packages use CommunityToolkit.Aspire.Hosting.*; client packages use CommunityToolkit.Aspire.*.
  • Hosting extension methods use the Aspire.Hosting namespace.
  • Client extension methods use the Microsoft.Extensions.Hosting namespace.
  • Hosting resource types normally use Aspire.Hosting.ApplicationModel.
  • Use file-scoped namespaces and the repository's existing formatting.
  • All public APIs require XML documentation.
  • Validate public inputs with the established .NET throw helpers used by nearby integrations.
  • Prefer is null and is not null over equality checks with null.
  • Do not manually edit generated */api/*.cs files unless API baseline regeneration is explicitly required.

Working approach

  • Start with the integration being changed, then inspect its tests, example, README, and one or two same-pattern integrations.
  • Use the applicable files under .github/instructions/ for path-specific guidance.
  • Use focused workflows under .agents/skills/ for specialized tasks.
  • Keep changes scoped to the requested integration and avoid unrelated refactoring.
  • Run the narrowest relevant build or test command. The repository treats warnings as errors.

Key references

  • Creating an integration
  • Development environment
  • Contributing
  • Diagnostics
  • Versioning

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.