Skip to content

Contributing

Preview Aspire ResourceKit Reviewed 2026-09-16 purview-dev/aspire-resourcekit apphost aspire cloud-native code-generation csharp developer-tools distributed-systems dotnet dotnet-aspire integration-testing resource-management roslyn source-generators testing

Contributing

Section titled “Contributing”

This page covers the repository layout and the day-to-day commands for working on Purview.Aspire.ResourceKit. It is aimed at contributors, not consumers.

Repository layout

Section titled “Repository layout”
  • src/src/ResourceKit — runtime APIs consumed by AppHost projects (the packable project).
  • src/src/SourceGeneration — the Roslyn incremental generator, analyzers, suppressor, and attributes.
  • src/src/SourceGeneration.CodeFixes — the SG0020 IDE code fix provider.
  • src/src/Example.* — sample Aspire applications (Example.AppHost generated pattern, Example.ManualAppHost manual pattern, Example.Service, Example.ServiceDefaults).
  • src/tests/* — unit and integration tests for the runtime and the generator.
  • docs/wiki — this documentation suite.

The NuGet package is produced from src/src/ResourceKit/ResourceKit.csproj and includes the runtime APIs plus the analyzer/code-fix assemblies.

Building and testing

Section titled “Building and testing”

The repository uses Just recipes (see Justfile). All recipes run from the repository root.

Terminal window
just build          # build the solution (Debug)
just test           # run all tests
just test-unit      # run unit tests only (TUnit [Category=Unit] filter)
just restore        # restore dependencies
just pack           # produce NuGet packages into ./artifacts
just lint-check     # CSharpier formatting check
just lint-fix       # CSharpier format
just scrub          # remove bin/obj, clean, restore, stop build server
just version        # show the current version from package.json

Testing conventions

Section titled “Testing conventions”
  • Tests use TUnit (and TUnit.Mocks); do not introduce NUnit, xUnit, or MSTest patterns.
  • All tests follow AAA with explicit // Arrange, // Act, // Assert comments.
  • Test names mirror production structure: {ClassUnderTest}Tests and {SubjectOrMethodUnderTest}_{Scenario}_{Expectation}.
  • When a method under test accepts a CancellationToken, pass one and make it the final argument.
  • Unit tests are tagged [Category=Unit] and are the only tests CI runs.

Test projects:

  • src/tests/ResourceKit.UnitTests — runtime behavior (host app resources, OptionsHelper).
  • src/tests/ResourceKit.IntegrationTests — starts the example AppHosts via TUnit.Aspire.
  • src/tests/SourceGeneration.UnitTests — generator diagnostics/severity and attributes.
  • src/tests/SourceGeneration.IntegrationTests — generated source content, caching, diagnostics, suppression, and the SG0020 code fix.

Reports are written to TestResults/.

Agent skills and workflows

Section titled “Agent skills and workflows”

The repository carries agent skills and prompt workflows under .agents/. Consult them when working on source generators, tests, the project SDK, or conventional commits. AGENTS.md is the canonical agent guidance and references .agents/ for reusable workflows.

Pull requests

Section titled “Pull requests”

Pull requests target main and are validated by .github/workflows/pr.yml, which delegates to the shared Purview.Build pipeline (restore, build, CSharpier lint, unit tests, pack, package-content validation). See Release Flow.

Commits follow Conventional Commits, enforced by commitlint and Lefthook hooks.