dotnet-best-practices

Guide .NET/C# projects through best-practice checklists for code quality and architecture.

18|3|Updated Jul 3, 2020
One-click install
npx skills add https://github.com/jguadagno/jjgnet-broadcast --skill dotnet-best-practices-jguadagno
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-best-practices
Source: https://github.com/jguadagno/jjgnet-broadcast/tree/main/.agents/skills/dotnet-best-practices
Command: npx skills add https://github.com/jguadagno/jjgnet-broadcast --skill dotnet-best-practices-jguadagno

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Developers often struggle to maintain consistent and high-quality code in .NET/C# projects. This Skill provides guidance to align codebases with best practices, improving maintainability and reliability.

Core Features & Use Cases

  • Code Quality Enforcement: Guides on XML documentation, design patterns, and dependency injection.
  • Code Review Assistance: Checks for adherence to SOLID principles, naming conventions, and resource management.
  • Use Case: A team wants to improve codebase consistency by enforcing standards and optimizing architecture using C# and .NET 8.

Quick Start

Use the dotnet-best-practices skill to get a checklist of coding standards for your project.

Frequently Asked Questions about dotnet-best-practices

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce C# and .NET best practices for code quality and architecture?

Enforce .NET best practices by applying guidelines for XML documentation, design patterns, and dependency injection. This ensures your C# codebase maintains high quality, consistency, and reliability across project setups and refactoring efforts.

What is the best way to check SOLID principles and naming conventions during a C# code review?

Checking SOLID principles during a C# code review involves verifying naming conventions, resource management, and dependency injection. This validates adherence to architecture standards and improves overall codebase maintainability.

How do I set up a .NET 8 project to follow industry standards for design patterns and async programming?

Set up a .NET 8 project for industry standards by configuring dependency injection, applying appropriate design patterns, and implementing async programming guidelines. This alignment establishes a consistent, high-quality architectural foundation.

Can I use this approach to improve an existing C# codebase through refactoring?

Yes, you can improve an existing C# codebase through refactoring. It provides targeted guidance on optimizing architecture, aligning code with SOLID principles, and implementing proper resource management for better reliability.

What coding standards should I include in a checklist for a C# and .NET project?

A C# and .NET coding standards checklist should include XML documentation, design patterns, dependency injection, async programming, testing, and security guidelines. This ensures comprehensive coverage of industry best practices for development workflows.

When do I need specific guidelines for async programming and dependency injection in .NET?

You need specific guidelines for async programming and dependency injection in .NET during project setups and refactoring efforts. These guidelines ensure proper resource management, maintainability, and reliable architectural alignment.