- Deploying Supplemental Documentation
- Packages
- Development Setup
- Contributing
$: cd documentation
$: npx cross-env CURRENT_BRANCH=main USE_SSH=true GIT_USER={GITHUB_USERNAME} GIT_PASS={GITHUB_PASSWORD} docusaurus deploy
Commonly used interfaces, patterns and utilities by the HCD engineering team at RSM
This package is installed via NuGet
dotnet add [<PROJECT>] package RSM.HCD.CSharp.Core
Commonly used CSharp extension methods used by the HCD engineering team at RSM.
This package is installed via NuGet
dotnet add [<PROJECT>] package RSM.HCD.CSharp.Extensions
After installation, simply import the extensions namespace to gain access to all of the available extension methods
using System;
using System.Collection.Generic;
using RSM.HCD.CSharp.Extensions;
public class Program
{
public static int Main(string[] args)
{
new List<string>().IsEmpty(); // returns true
}
}
Commonly used CSharp testing code used by the HCD engineering team at RSM.
This package is installed via NuGet
dotnet add [<PROJECT>] package RSM.HCD.CSharp.Testing
Commonly used interfaces, patterns and utilities for writing conductors by the HCD engineering team at RSM.
This package is installed via NuGet
dotnet add [<PROJECT>] package RSM.HCD.CSharp.Conductors
TODO: In-depth documentation on test factories
Using the FactorySettings
singleton class you can configure test factories. To access properties use the singleton instance FactorySettings.Instance.{property|method};
To enable debug output set the Debug
setting to true
. Now warnings will be output via standard out for troubleshooting purposes. By default, only exceptional cases will be output.
- Install Dotnet Core 3.1
- Install the
and-cli
tooling found at AndcultureCode.Cli
Below are a few basics to get you started, but there are many more commands and options for managing this and other projects found in the and-cli
.
-
Run the build command
and-cli dotnet --build
-
Run the test command
and-cli dotnet-test
-
Run the test command
and-cli dotnet-test --coverage
-
Open the
coverage.opencover.xml
file in your browser
-
Run the publish command with the next version number (See semver package versioning)
and-cli nuget --publish <version>
Information on contributing to this repo is in the Contributing Guide