rm-guide-code-quality

Enforce clarity and null-safety in C# code reviews.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides clear guardrails that keep C# reviews focussed on readability, maintainability, and consistent null handling instead of clever but confusing constructs.

Core Features & Use Cases

  • Style First: Encourages clarity, restrained expression-bodied usage, and adding XML docs when they enhance discoverability.
  • Null Safety & Immutability: Advocates the use of records for immutable DTOs and is null/is not null checks to reduce bugs.
  • Use Case: When shaping public APIs or reviewing DTOs, keep methods small, focused, and guided by these readability principles.

Quick Start

Review the provided C# API to enforce clarity, prefer records for immutable DTOs, and use is-not-null checks for null handling.

Frequently Asked Questions about rm-guide-code-quality

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

FAQPage Schema
How do I enforce null-safety and readability in C# code reviews?

Enforce null-safety and readability in C# code reviews by applying guardrails that require `is null` checks, prefer records for immutable DTOs, and keep expression-bodied members small and focused to avoid confusing constructs.

What is the best way to review immutable DTOs in .NET service code?

The best way to review immutable DTOs in .NET service code is to advocate for using C# records, which enforce immutability, alongside precise XML documentation to enhance API discoverability and maintainability.

When should I use `is null` checks instead of equality operators for C# public APIs?

Use `is null` and `is not null` checks for C# public APIs to reduce bugs and enforce consistent null handling, replacing clever or confusing equality operator constructs with clear pattern matching.

How do I evaluate expression-bodied members for maintainability during a C# review?

Evaluate expression-bodied members for maintainability during a C# review by ensuring methods remain small and focused, applying restrained usage of expression-bodied syntax to prioritize clarity over concise but confusing constructs.

Does this C# readability guide require XML documentation for all public APIs?

This C# readability guide encourages adding XML docs to public APIs when they enhance discoverability, maintaining precision in documentation rather than mandating it universally across all evaluated methods.