What problem does it solve?
C# conventions, patterns, and tooling are often inconsistently applied across projects, leading to maintenance headaches and onboarding delays. This skill standardizes how C# code should be documented, structured, and tested, reducing friction and improving code quality. It also provides a ready-to-use set of guidelines for teams adopting .NET practices.
Core Features & Use Cases
- Documentation comments: Use XML doc comments to document public APIs and behavior.
- Testing and quality: Emphasizes xUnit or similar testing patterns and test organization.
- Dotnet tooling: Provides guidance on common commands like dotnet build, dotnet test, and dotnet format.
- Design patterns: Encourages Dependency Injection, IOptions<T>, ILogger<T>, and Async/await with CancellationToken for robust, maintainable code.
- Use Case: Apply these conventions when starting a new C# project or refactoring an existing codebase to improve consistency and maintainability.
Quick Start
Apply these conventions to initialize and align a C# project for consistent code quality and tooling.