Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

22 lines (18 loc) · 1.41 KB

Contributor guide

Pull requests

Pull requests are welcome!
Please include a clear description of the changes you have made with your request; the title should follow the conventional commits guideline. All code should be covered by unit tests and comply with the coding guideline in this project.

Technical expectations

As a framework for supporting unit testing, this project has a high standard for testing itself.
In order to support this, static code analysis is performed using SonarCloud with quality gate requiring to

  • solve all issues reported by SonarCloud
  • have a code coverage of > 90%

Additionally each push to the main branch checks the quality of the unit tests using Stryker.NET.

Versioning

This project uses MinVer for versioning.
Tags are automatically added during a release build. In order to trigger a release, create a release branch. After all tests are successful and the manual check is approved, that Tag is automatically applied and Nuget Packages are pushed to nuget.org. Release branches must follow the following naming convention:

    `release/v{major}.{minor}.{revision}`