moq-analyzers-rule-lifecycle

Guide Moq.Analyzers maintainers through adding, modifying, and releasing analyzer rules.

24|4|Updated Nov 25, 2017
One-click install
npx skills add https://github.com/rjmurillo/moq.analyzers --skill moq-analyzers-rule-lifecycle
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: moq-analyzers-rule-lifecycle
Source: https://github.com/rjmurillo/moq.analyzers/tree/main/.github/skills/moq-analyzers-rule-lifecycle
Command: npx skills add https://github.com/rjmurillo/moq.analyzers --skill moq-analyzers-rule-lifecycle

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires Nerdbank.GitVersioning, Moq, Roslyn, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance on adding, modifying, and releasing analyzer rules within the Moq.Analyzers project, covering every step of the lifecycle.

Core Features & Use Cases

  • Rule Addition: Walks through the process of adding a new rule to the project, including code and documentation updates.
  • Rule Modification: Outlines how to change a shipped rule's severity or category and prepare for release.
  • Release Management: Documents the versioning model, release steps, and necessary verification for publishing a new version of Moq.Analyzers.

Quick Start

Use the moq-analyzers-rule-lifecycle skill to learn about adding a new Moq1XXX rule in Moq.Analyzers.

Frequently Asked Questions about moq-analyzers-rule-lifecycle

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

FAQPage Schema
How do I add a new analyzer rule to Moq.Analyzers?

To add a new analyzer rule in Moq.Analyzers, you must update both the project code and its accompanying documentation. This ensures the new diagnostic rule is properly registered and discoverable for consumers.

What is the process for changing a shipped Moq analyzer rule's severity?

Modifying a shipped Moq analyzer rule requires updating its severity or category settings and then preparing the project for a subsequent release. This maintains consistency across deployed analyzer versions.

How does versioning work when releasing Moq.Analyzers?

Releasing Moq.Analyzers relies on a specific versioning model to track diagnostic rule changes. The process involves executing defined release steps and performing necessary verifications before publishing a new package version.

When do I need to update release notes for Moq analyzer rules?

You need to maintain release notes whenever adding new rules, modifying existing ones, or preparing a new Moq.Analyzers publication. This documentation tracks all lifecycle changes for maintainers and contributors.

Can I use Nerdbank.GitVersioning to manage Moq.Analyzers releases?

Nerdbank.GitVersioning is a required dependency for managing the Moq.Analyzers release lifecycle. It provides the versioning infrastructure necessary to publish consistent and traceable analyzer rule updates.

What are the limitations when modifying shipped Roslyn analyzer rules in Moq?

When modifying shipped Roslyn analyzer rules in Moq, you must follow strict lifecycle steps to avoid breaking existing consumer builds. Changes require careful versioning and release preparation to manage compatibility.