Skip to content

Correct analyzer count and remove StyleCop from CONTRIBUTING.md #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Chris-Wolfgang merged 3 commits into from
Feb 2, 2026
Merged

Correct analyzer count and remove StyleCop from CONTRIBUTING.md #46

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf5cb66
Initial plan
Copilot Feb 2, 2026
086ce39
Update CONTRIBUTING.md: correct analyzer count to 7 and remove StyleCop
Copilot Feb 2, 2026
333317b
Update CONTRIBUTING.md
Chris-Wolfgang Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can contribute in several ways:
- Building the project
- Running automated tests
- Checking code style and linting
- Running static analysis with 8 different analyzers
- Running static analysis with 7 different analyzers

**It is important to make sure that all CI steps pass before your PR can be merged.**
- If any CI step fails, please review the error messages and update your PR as needed.
Expand All @@ -49,42 +49,38 @@ You can contribute in several ways:

This project maintains **extremely high code quality standards** through multiple layers of static analysis and automated enforcement.

### The 8 Analyzers
### The 7 Analyzers

All code is analyzed by these tools during build:

1. **Microsoft.CodeAnalysis.NetAnalyzers** (Built-in .NET SDK)
- Correctness, performance, and security rules
- Latest analysis level enabled

2. **StyleCop.Analyzers**
- Enforces consistent code style and formatting
- Documentation comment requirements

3. **Roslynator.Analyzers**
2. **Roslynator.Analyzers**
- 500+ refactoring and code quality rules
- Advanced C# pattern detection

4. **AsyncFixer**
3. **AsyncFixer**
- Detects async/await anti-patterns
- Ensures proper `ConfigureAwait()` usage
- Prevents fire-and-forget async calls

5. **Microsoft.VisualStudio.Threading.Analyzers**
4. **Microsoft.VisualStudio.Threading.Analyzers**
- Thread safety enforcement
- Async method naming conventions
- Deadlock prevention

6. **Microsoft.CodeAnalysis.BannedApiAnalyzers**
5. **Microsoft.CodeAnalysis.BannedApiAnalyzers**
- Blocks usage of APIs listed in `BannedSymbols.txt`
- Enforces async-first patterns (see below)

7. **Meziantou.Analyzer**
6. **Meziantou.Analyzer**
- Comprehensive code quality checks
- Performance optimizations
- Best practice enforcement

8. **SonarAnalyzer.CSharp**
7. **SonarAnalyzer.CSharp**
- Industry-standard code analysis
- Security vulnerability detection
- Code smell identification
Expand Down