SharpHoundCommon Contributing Guide

Prerequisites

Tools

• .NET SDK

Build

dotnet build

Unit Test

This project is configured to generate test coverage every time tests are run and produces a HTML report at ./docfx/coverage/report.

dotnet test

Documentation

Documentation is generated into HTML from Markdown using docfx.

To build the docs:

dotnet build docfx

To preview the docs:

dotnet build docfx
dotnet build docfx -t:Serve

To preview the docs with test coverage:

dotnet test
dotnet build docfx
dotnet build docfx -t:Serve