Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (35 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 2.26 KB
Raw

Contributing

Thanks for helping improve HttpClient.Resilience.Analyzers.

This project is intentionally high-signal. A diagnostic should prevent a plausible production failure, avoid surprising false positives, and include documentation that helps teams make the right tradeoff.

Development Setup

Prerequisites:

  • .NET SDK from global.json
  • PowerShell 7 or later

Restore, build, and test:

dotnet restore HttpClient.Resilience.Analyzers.slnx
dotnet build HttpClient.Resilience.Analyzers.slnx --configuration Release --no-restore
dotnet test HttpClient.Resilience.Analyzers.slnx --configuration Release --no-build

Run the full local gate before opening a pull request:

dotnet format HttpClient.Resilience.Analyzers.slnx --verify-no-changes --exclude samples
dotnet build HttpClient.Resilience.Analyzers.slnx --configuration Release --no-restore
./scripts/Validate-Repository.ps1
./scripts/Validate-SampleDiagnostics.ps1 -NoRestore
dotnet test HttpClient.Resilience.Analyzers.slnx --configuration Release --no-build --logger trx --results-directory artifacts\test-results
dotnet pack src\HttpClient.Resilience.Analyzers.Package\HttpClient.Resilience.Analyzers.Package.csproj --configuration Release --no-build --output artifacts\packages
$package = Get-ChildItem artifacts\packages\*.nupkg | Sort-Object LastWriteTime -Descending | Select-Object -First 1
./scripts/Validate-Package.ps1 -PackagePath $package.FullName
./scripts/Validate-PackageConsumption.ps1 -PackagePath $package.FullName

Diagnostic Quality Bar

For a new or expanded diagnostic, include:

  • Analyzer coverage for the bad pattern and common safe patterns.
  • False-positive tests for lookalike custom APIs when type information is available.
  • Documentation under docs/rules/ with why, bad, better, current detection, suppression, and references.
  • A sample project case when the diagnostic is part of the public configured set.
  • Release metadata in AnalyzerReleases.Unshipped.md.

Code fixes should be conservative and limited to transformations that are obviously safe.

Pull Requests

Keep pull requests focused. Prefer one diagnostic or one infrastructure concern per pull request. Include the verification commands you ran and call out any known limitations that remain intentional.