dotnet / roslyn-analyzers-contrib

Replaced by dotnet/roslyn-analyzers.
https://github.com/dotnet/roslyn-analyzers
Apache License 2.0
16 stars 11 forks source link

Roslyn SDK/guidelines #2

Open michaelcfanning opened 8 years ago

michaelcfanning commented 8 years ago

This discussion relates to the guidelines and supporting code we perceive as valuable to drive quality and consistency in the Roslyn analyzer eco-system. Supporting test infrastructure is covered in a separate issue.

Useful guidelines/SDK content includes:

1) Standards for analyzer binary factoring/naming (for core code, language-specific code, nuget/installers, etc) 2) Standards for organizing checks, including granularity of analysis. 3) Example use and guidance for of all diagnostic metadata fields 4) Specific guidance around authoring user-facing strings.
5) File naming conventions for analyzer and test code (for example, see section 6.9.3 of the SARIF specification on this topic, at https://github.com/sarif-standard/sarif-spec) 6) Build out Roslyn diagnostics analyzers to assist in enforcing development practices and Roslyn API use.