Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (22 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.37 KB
Raw

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%

Building and testing

dotnet build Testably.Abstractions.Migration.slnx builds everything; ./build.ps1 UnitTests --configuration Release (or ./build.sh UnitTests) runs the tests like the CI.

All tests run on TUnit and the Microsoft.Testing.Platform, which global.json selects for dotnet test. Pass a single project with --project and filter with --treenode-filter:

dotnet test
dotnet test --project Tests/Testably.Abstractions.Migration.Tests
dotnet test --project Tests/Testably.Abstractions.Migration.Tests --treenode-filter "/*/*/SystemIOAbstractionsCodeFixProviderTests+FixAllTests/*"