Skip to content

AGENTS.md

Latest commit

 

History

History
82 lines (61 loc) · 2.79 KB

AGENTS.md

File metadata and controls

82 lines (61 loc) · 2.79 KB
Raw

AGENTS.md

.NET / C# solution. Replace the bracketed bits with your project's details.

Stack

  • .NET 8.0 (LTS) SDK, C# 12, nullable reference types enabled.
  • Build/test: dotnet CLI 8.0.x. Tests: xUnit. Format: dotnet format.

Setup

dotnet restore           # restore NuGet packages
cp .env.example .env     # local config; never commit .env

Commands

dotnet run --project src/Api            # run the API project
dotnet build -c Release                 # build
dotnet test                             # run all tests
dotnet test --filter FullyQualifiedName~OrderServiceTests   # one test class
dotnet format                           # apply formatting + analyzers
dotnet format --verify-no-changes       # format check (used in CI)

Project Structure

  • src/Api/ — entry-point web/API project (Program.cs, controllers).
  • src/<Domain>/ — domain & application class libraries.
  • tests/<Project>.Tests/ — xUnit test projects, one per src project.
  • *.sln, Directory.Build.props — solution and shared MSBuild settings.
  • appsettings.json, .env.example — config templates (no secrets).

Code style

  • Nullable is on: treat warnings as errors; do not sprinkle ! null-forgiving.
  • Use async/await end-to-end; suffix async methods with Async.
  • Prefer records for DTOs; keep services injected via the DI container.

Example — an async service method:

public sealed class OrderService(IOrderRepository repo)
{
    public async Task<Order> GetAsync(long id, CancellationToken ct)
    {
        return await repo.FindAsync(id, ct)
            ?? throw new OrderNotFoundException(id);
    }
}

Testing

  • Test projects named *.Tests; mirror the namespace under test.
  • A change is done when dotnet format --verify-no-changes and dotnet test pass.
  • Add a failing test first, then make it pass (TDD).

Git & PRs

  1. Branch from main: git switch -c feat/<short-name>.
  2. Conventional Commits (feat:, fix:, chore:).
  3. Before pushing: dotnet format --verify-no-changes && dotnet build -c Release && dotnet test.
  4. PR description: one-line summary + the test command you ran.

Boundaries

  • Always: read .env.example / appsettings.json for config keys.
  • Always: edit project source under src/ and add tests under tests/.
  • Always: add a new EF Core migration (dotnet ef migrations add) for schema changes.
  • Always: fix the root cause when an analyzer flags code.
  • Ask first: before adding NuGet packages or changing .csproj TargetFramework.
  • Ask first: before editing an already-applied migration's Up/Down.
  • Never commit secrets, .env, or appsettings.*.json with real values.
  • Never suppress analyzer warnings with #pragma warning disable to pass CI.

More

  • Project/layer layout: docs/architecture.md.