Conventional
Conventional copied to clipboard
A suite of convention specifications for enforcing type and style conventions in your codebase
Conventional

Conventional provides a suite of ready-made tests for enforcing conventions within your types, assemblies, solutions and databases to make sure your duckies are all in a row.
Conventional targets .NET Standard 2.0, and as of Conventional 7.x, Conventional ❤'s Linux!
To install from NuGet
Install-Package Best.Conventional
Documentation
To get started with Conventional, please check out the wiki for a comprehensive list of included conventions, sample usages, and configuration information.
Examples
Not sure how to get started with Conventional? Check out the sample repository which contains a bunch of real-world usage examples
Roslyn-based conventions
As of This PR Roslyn conventions are now supported on Dotnet Core.
Install-Package Best.Conventional.Roslyn
Rolsyn-based conventions target netcoreapp3.1
. Check out the documentation for more information.
Contributing
Conventional's test suite requires a default named .\SQLEXPRESS
instance. If you have another instance you would like to use for development, create a copy of development.settings.example
in the solution root and rename to development.settings
, and supply your own connection string.
License
Licensed under the terms of the MS-PL license