https://github.com/andrewabest/conventional

A suite of convention specifications for enforcing type and style conventions in your codebase
https://github.com/andrewabest/conventional

c-sharp conventions quality-assurance testing testing-tools

Last synced: 6 months ago
JSON representation

A suite of convention specifications for enforcing type and style conventions in your codebase

• Host: GitHub
• URL: https://github.com/andrewabest/conventional
• Owner: andrewabest
• License: ms-pl
• Created: 2015-01-04T02:11:53.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-12T23:04:49.000Z (over 1 year ago)
• Last Synced: 2024-05-17T10:21:09.043Z (over 1 year ago)
• Topics: c-sharp, conventions, quality-assurance, testing, testing-tools
• Language: C#
• Homepage:
• Size: 85.5 MB
• Stars: 98
• Watchers: 6
• Forks: 29
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
Conventional [![Build status](https://ci.appveyor.com/api/projects/status/b34y026n60v9oe16/branch/master?svg=true)](https://ci.appveyor.com/project/andrewabest/conventional/branch/master)

[![NuGet](https://img.shields.io/nuget/v/Best.Conventional.svg)](https://www.nuget.org/packages/Best.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!

![](https://raw.github.com/andrewabest/Conventional/master/duck.png)

## To install from NuGet

    Install-Package Best.Conventional

## Documentation

To get started with Conventional, please check out [the wiki](https://github.com/andrewabest/Conventional/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](https://github.com/andrewabest/Conventional.Samples) which contains a bunch of real-world usage examples

## Roslyn-based conventions

[![Build status](https://ci.appveyor.com/api/projects/status/qrxqsfh0d5jwc5ns/branch/master?svg=true)](https://ci.appveyor.com/project/andrewabest/conventional-roslyn/branch/master)

[![NuGet](https://img.shields.io/nuget/v/Best.Conventional.Roslyn.svg)](https://www.nuget.org/packages/Best.Conventional.Roslyn/)

    Install-Package Best.Conventional.Roslyn

Rolsyn-based conventions target `net6.0`. Check out [the documentation](https://github.com/andrewabest/Conventional/wiki/Roslyn-Conventions) 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](https://opensource.org/licenses/MS-PL) license