Skills
.Work. You
Rest

csharp-api-design

Community

Design stable C# APIs with extend-only design.

Software Engineering#design#versioning#compatibility#API design#C##NuGet#extend-only
Authorakoken
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps teams design stable, forward-compatible public APIs for C# libraries by applying extend-only design principles. It guides API compatibility, wire compatibility, and versioning to minimize breaking changes in NuGet packages and distributed systems.

Core Features & Use Cases

  • Extend-only design to prevent breaking changes while enabling new functionality
  • API compatibility guidance across releases (API/Source, Binary, and Wire)
  • Versioning strategies and deprecation patterns for smooth migrations
  • Wire-compatibility planning for distributed components and serialized data
  • PR review prompts to enforce non-breaking changes and migration paths
  • Use Case: adding a new feature via overloads or new types without removing existing APIs

Quick Start

Ask: Outline a non-breaking API change for a hypothetical C# library, including how to add new overloads and deprecate old members.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: csharp-api-design
Download link: https://github.com/akoken/dotfiles/archive/main.zip#csharp-api-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.