Skip to content

AGENTS.md

Latest commit

 

History

History
40 lines (30 loc) · 2.43 KB

AGENTS.md

File metadata and controls

40 lines (30 loc) · 2.43 KB
Raw

CSharpEssentials — Agent Instructions

What

CSharpEssentials is a modular .NET NuGet ecosystem (19 packages) that bridges OOP and Functional Programming in C#. Core patterns: Result/Maybe monads, Discriminated Unions (Any<T1,T2,...>), composable Rules engine, DDD base classes (EntityBase), EF Core interceptors/pagination, and ASP.NET Core utilities. Multi-targets: .NET 9/8, netstandard2.1/2.0. Current version: 3.0.0.

Why

  • Nullable + TreatWarningsAsErrors: Prevents null reference bugs at compile time; every package must be null-safe by design.
  • Modular packages: Users take only what they need; CSharpEssentials meta-package bundles core functional modules.
  • SonarAnalyzer.CSharp: Static analysis in every build via Directory.Build.props — consistent quality across all packages without per-project config.
  • Central Package Management (Directory.Packages.props): Single version source-of-truth; prevents version drift across packages.
  • No abstract layers for the sake of it: Every abstraction (IDateTimeProvider, IDomainEventPublisher) exists to enable testability or infrastructure-swapping, not ceremony.

How

  • Build: dotnet build
  • Test: dotnet test
  • Pack: dotnet pack
  • Publish: ./build-and-publish-nugets.sh
  • First-time setup: git config core.hooksPath .githooks (activates pre-commit badge validation)
  • Naming: PascalCase types, camelCase locals, _camelCase private fields
  • File layout: One public type per file, filename matches type name
  • Tests live in CSharpEssentials.Tests/

Don't

  • Don't use dynamic type — defeats the purpose of the type-safe libraries.
  • Don't suppress warnings with #pragma warning disable — fix the root cause.
  • Don't add // TODO to committed code — either implement it or track it as an issue.
  • Don't add new packages to Directory.Packages.props without checking existing entries.
  • Don't break multi-targeting — test against all declared target frameworks.
  • Don't add docstrings or comments unless explicitly asked.
  • Don't create placeholder/stub implementations.

Boundaries

  • Always: Write tests, follow nullable annotations, use conventional commits, run build before committing.
  • Ask first: Adding new NuGet packages, changing shared abstractions (interfaces in .Core/.Entity), bumping major version, removing public API.
  • Never: Commit secrets, edit .snupkg/.nupkg artifacts, push directly to main, suppress TreatWarningsAsErrors.