Six Cursor Rules

![Six Cursor Rules](.cursor/six-cursor-rules-banner-wide-1980-01.png)

# Six Cursor Rules

A comprehensive collection of Cursor AI assistant rules designed to enhance software development quality, consistency,
and productivity.

This project provides structured guidelines covering:

- **Technical documentation** - Standards for writing and maintaining project documentation
- **.NET ecosystem** - ASP.NET, Avalonia, Blazor, CI/CD, and related technologies
- **C# development** - Language-specific coding standards and best practices
- **Web technologies** - Astro, TypeScript, and modern web development frameworks
- **Specification-driven development** - Structured approaches to requirements and implementation
- **General software engineering practices** - Coding standards, testing, benchmarking, dependency management, and package publishing

## What are Cursor Rules?

Cursor Rules are configuration files (`.mdc` format) that guide AI assistants in Cursor IDE to follow specific
development practices, coding standards, and workflow patterns. These rules ensure consistent code quality, proper
documentation, and adherence to industry best practices across different domains and technologies.

## Installation

To use these Cursor Rules in your project:

1. **Copy the rules** - Copy the desired `.mdc` rule files from this repository to your project's `.cursor/rules/`
   directory
2. **Create the directory** - If the `.cursor/rules/` directory doesn't exist, create it in your solution root
3. **Restart Cursor** - Restart Cursor IDE to ensure the new rules are loaded
4. **Verify activation** - The AI assistant will automatically apply these rules when working in your project


## .NET Development Rules

### 🔧 [General .NET](rules/dotnet/general/README.md)
#### [Solution Management](rules/dotnet/general/dotnet-solution.mdc)
Rules for maintaining .NET solutions with consistent SDK versions, shared metadata, and secure package sources. Ensures 
cross-project consistency, maintainability, and security using Six.SolutionTemplate as the foundation.

#### [Library Development](rules/dotnet/general/dotnet-library.mdc)
Rules for creating high-quality .NET libraries with proper metadata, SourceLink integration, and NuGet publishing. Focuses on package discoverability, documentation, and following NuGet conventions for maximum ecosystem compatibility.

#### [Dependency Management](rules/dotnet/general/dotnet-dependency-management.mdc)
Rules for managing NuGet dependencies with security focus, version control, and migration strategies. Addresses package vulnerabilities, license compliance, and maintaining healthy dependency graphs across .NET projects.

#### [Testing Best Practices](rules/dotnet/general/dotnet-testing.mdc)
Rules for testing strategies including unit, integration, and performance testing with xUnit, BenchmarkDotNet, and 
Coverlet. Emphasizes test isolation, Arrange-Act-Assert patterns, and automated testing workflows.

#### [Benchmarking Guidelines](rules/dotnet/general/dotnet-benchmarking.mdc)
Rules for performance benchmarking best practices using BenchmarkDotNet for measuring and optimizing .NET code 
performance. Covers memory analysis, async performance testing, and CI/CD integration for continuous performance monitoring.

#### [Documentation Standards](rules/dotnet/general/dotnet-docs.mdc)
Rules for writing technical documentation in `docs/rules/content/docs/` with proper structure and formatting. Ensures consistent documentation quality and discoverability across .NET projects.


### 💻 [C#](rules/dotnet/csharp/README.md)
#### [C# Coding Style](rules/dotnet/csharp/csharp-coding-style.mdc)
Rules for writing clean, maintainable, and idiomatic C# code with functional patterns and modern language features. Emphasizes readability, proper abstractions, and leveraging C# 13+ features for optimal code quality.

#### [C# Scripting](rules/dotnet/csharp/csharp-scripting-style.mdc)
Rules for C# scripting with .NET, including single-file applications, package directives, and rich console output. Covers Spectre.Console for CLI applications and CliWrap for external process management.



### 🏗️ [ASP.NET Core Development](rules/dotnet/aspnet/README.md)
#### [ASP.NET Core API](rules/dotnet/aspnet/aspnet-api.mdc)
Rules for building secure, scalable ASP.NET Core APIs using Minimal APIs and modern patterns. Covers dependency injection, error handling, security, performance optimization, and comprehensive API documentation.

#### [Fast Endpoints API](rules/dotnet/aspnet/aspnet-api-fast-endpoints.mdc)
Rules for building high-performance ASP.NET Core APIs using the Fast Endpoints framework. Focuses on endpoint architecture, validation, security, performance optimization, and comprehensive testing strategies.

#### [Orleans Development](rules/dotnet/aspnet/aspnet-orleans.mdc)
Rules for developing distributed applications using the Microsoft Orleans framework. Covers grain development, 
clustering, persistence, and integration with

... (truncated)