Neolution.CodeAnalysis 3.0.3

Neolution Code Analysis rulesets

We maintain two (opinionated) rulesets for all our projects and distribute them, including 3rd-party Roslyn Analyzers (StyleCop and SonarSource) in two respective NuGet packages.

• For Libraries, Tools, Web, UI and other projects
  • Neolution.CodeAnalysis
• For projects containing automated tests (less strict rules)
  • Neolution.CodeAnalysis.TestsRuleset

Decisions and opinions

The base ruleset consists of the default ruleset of the Roslyn Analyzers we include in the NuGet package and those used in our build tools.

• We include our own opinionated ruleset with adjusted Analyzer severities as a Global AnalyzerConfig
• In all build configurations other that Debug, warnings will be converted to errors.
• We include our own stylecop.json configuration file.

Versioning

Given a version number MAJOR.MINOR.PATCH, an incremented number for:

• MAJOR version means there are incompatible changes with the previous version,
• MINOR version means functionality and rules were added, and
• PATCH version means that the changes are all completely backwards compatible. Usually when rules were lowered in severity or disabled/removed.

What it means in practice:

• You can (and should) always update the package to the latest PATCH version whenever you have the chance to do it, it should never break the build.
• Updating to the latest MINOR version can break the build and may require minor refactorings. But you can expect to have Roslyn code fixes and/or documentation available for the changes that are needed to fix the build.
• MAJOR updates will break your build and may require major refactorings.