CommonHelpers: Instructions file for GitHub Copilot

CommonHelpers Repository Instructions

Repository structure

• src/CommonHelpers is the core netstandard2.0 library and produces the CommonHelpers NuGet package.
• src/CommonHelpers.Maui is the .NET 10 MAUI companion package and consumes CommonHelpers.
• src/CommonHelpers.Tests is the .NET 10 MSTest project.
• GitHub Actions workflows run on Windows and use the .NET 10 SDK.

Testing conventions

• The test project uses MSTest, Microsoft.NET.Test.Sdk, GitHubActionsTestLogger, and coverlet.collector.

• Keep coverlet.collector private to the test project. All workflows request the XPlat Code Coverage collector with OpenCover output.

• CI builds CommonHelpers before building the test project. Build the tests with:

  dotnet restore --runtime any --ignore-failed-sources
  dotnet build -c Release --no-restore --no-dependencies
  

• Run the already-built tests with:

  dotnet test -c Release --no-build --logger GitHubActions --blame-crash --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover
  

• Do not add --runtime any to the dotnet test --no-build command. The test build produces bin\Release\net10.0\CommonHelpers.Tests.dll; specifying that runtime makes the test runner incorrectly look under net10.0\any.

• Keep --no-dependencies on the test build. Without it, the project reference rebuilds and repackages CommonHelpers, causing duplicate SBOM generation and manifest-deletion warnings.

• Cancellation tests should assert the public cancellation contract through OperationCanceledException unless an exact subtype is part of the API contract. Use deterministic canceled tasks such as Task.FromCanceled<T> rather than scheduling-dependent Task.Run cancellation.

• MSTest equality assertions always use expected value first and actual value second:

  Assert.AreEqual(expected, actual);
  Assert.AreNotEqual(notExpected, actual);