dotnet-csharp-api-design

What problem does it solve?

This Skill provides guidance on designing public .NET APIs that are intuitive, consistent, and forward-compatible, reducing developer friction and improving maintainability.

Core Features & Use Cases

• Naming Conventions: Establishes clear rules for types, methods, and parameters.
• Parameter Ordering & Overloads: Ensures consistent and predictable method signatures.
• Return Type Selection: Guides the choice of appropriate return types for various scenarios (e.g., nullable, collections, async streams).
• Error Handling Strategies: Defines best practices for exceptions, the Try pattern, and result objects.
• Extensibility: Promotes design patterns that allow for future expansion without breaking changes.
• Wire Compatibility: Addresses considerations for serialized types to ensure backward compatibility.
• Use Case: When designing a new library, use this skill to ensure all public APIs adhere to established .NET design principles, making them easier for other developers to understand and use.

Quick Start

Follow the guidelines in this skill to design a new public API for a .NET library.