dotnet/runtime

Enable more style checking analyzers

Open

#78,414 opened on Nov 15, 2022

View on GitHub
 (17 comments) (0 reactions) (0 assignees)C# (5,445 forks)batch import
area-Metahelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

There are several analyzers that check for code style that runtime repo could benefit from if enabled. They are not too pedantic and could help to make the large codebase more readable.

For example

  • #94827
  • SA1107: Code should not contain multiple statements on one line
  • SA1119: A C# statement contains parenthesis which are unnecessary and should be removed.
  • SA1123: Region should not be located within a code element
  • SA1128: Put constructor initializers on their own line
  • SA1130: Use lambda syntax
  • #94098
  • SA1507: Code should not contain multiple blank lines in a row

Contributor guide

Research direction
Pick an unchecked item from the list (e.g., SA1107) and enable the corresponding analyzer in the project. Then fix any violations across the codebase.
Tech stack
csharp
Domain
backend
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75