Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 930 Bytes

CONTRIBUTING.md

File metadata and controls

18 lines (12 loc) · 930 Bytes

Contributing to Faithlife.Utility

Prerequisites

Guidelines

  • All new code must have complete unit tests.
  • All public classes, methods, interfaces, enums, etc. must have correct XML documentation comments. After updating the XML documentation comments, run .\build.ps1 -target=GenerateDocs to generate updated documentation that can be committed with the code.
  • Update VersionHistory with a human-readable description of the change.

How to Build

  • Clone the repository: git clone https://github.com/Faithlife/FaithlifeUtility.git
  • cd FaithlifeUtility
  • dotnet test tests/Faithlife.Utility.Tests