rm-guide-naming

Enforce C# naming conventions for types, members, namespaces, and test doubles.

Updated Nov 11, 2023
One-click install
npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill rm-guide-naming
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rm-guide-naming
Source: https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb/tree/main/.opencode/skills/redmuffin-standards/rm-guide-naming
Command: npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill rm-guide-naming

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It keeps C# teams from drifting into inconsistent identifier styles by codifying the naming rules for types, members, namespaces, and test doubles so every contribution matches the repo expectations.

Core Features & Use Cases

  • Clear Capitalization Rules: PascalCase for exported types and members, camelCase for locals and parameters, and _camelCase for private fields ensure readability and consistency.
  • Interface and Test Double Guidance: Interfaces stay prefixed with I and test doubles follow a [Class]_[Type] pattern to instantly reveal intent.
  • Use Case: While reviewing a pull request that renames services and adds mock implementations, apply the guide to validate that all new names align with the established conventions.

Quick Start

Ask rm-guide-naming to check the new C# names for PascalCase compliance and test double formatting before merging.

Frequently Asked Questions about rm-guide-naming

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

FAQPage Schema
What are the standard C# naming conventions for types, private fields, and locals?

Standard C# naming conventions require PascalCase for exported types and members, camelCase for locals and parameters, and _camelCase for private fields to ensure readability and consistency.

How do I format C# interface names and test doubles correctly?

To format C# interfaces and test doubles correctly, prefix interfaces with 'I' and apply a '[Class]_[Type]' pattern for test double suffixes to instantly reveal their intent.

How do I check C# code for PascalCase compliance before merging a pull request?

To check C# code for PascalCase compliance before merging, validate that all newly created or renamed types, members, and namespaces align with established capitalization rules.

When do I need to apply standardized naming conventions in C# refactoring?

You need to apply standardized naming conventions in C# refactoring when creating, renaming, or reviewing types, members, namespaces, and test doubles to prevent inconsistent identifier styles.

What is the best way to maintain consistent C# naming across a development team?

The best way to maintain consistent C# naming across a team is to codify rules for PascalCase, camelCase, _camelCase private fields, and interface prefixing so every contribution matches repository expectations.