Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.92 KB

CSharp.md

File metadata and controls

22 lines (15 loc) · 1.92 KB

C# Code Reviews

C# Style Guide

CSE developers follow Microsoft's C# Coding Conventions and, where applicable, Microsoft's Secure Coding Guidelines.

Linters

CSE projects should check code style with the StyleCop Analyzers for the .NET Compiler Platform. The minimum rules set teams should adopt is the Managed Recommended Rules rule set.

Documentation on setting up code analysis for a project is provided here.

Starter Code Review Checklist

  1. Is framework version of code compatible with the target system
  2. Does this code make correct use of asynchronous programming constructs, including proper use of await and Task.WhenAll?
  3. Are the middlewares included in this project configured correctly?
  4. Does the code handle exceptions correctly?
  5. Do new unit tests or changes to unit tests in this code actually test the business logic they purport to test?
  6. Is package management being used (NuGet) instead of committing DLLs?
  7. Does the code in this project use log levels consistently?
  8. Does this code us LINQ appropriately? Pulling LINQ into a project to replace a single short loop or in ways that do not perform well are usually not appropriate.