- Review the
CONTRIBUTING.mdfile for instructions to build and test the software. - Run the
.github/Prime-ForCopilot.ps1script (once) before running anydotnetormsbuildcommands. If you see any build errors about not finding git objects or a shallow clone, it may be time to run this script again.
- Design APIs to be highly testable, and all functionality should be tested.
- Avoid introducing binary breaking changes in public APIs of projects under
srcunless their project files haveIsPackableset tofalse.
- Tests use TUnit and Microsoft.Testing.Platform, with xUnit assertions. Pass
--treenode-filterafter--instead of VSTest--filter. - Run
tools/dotnet-test-cloud.ps1 -Configuration Releaseafter building to exclude tests markedFailsInCloudTest. Use-IncludeNativeAOTafter publishing NativeAOT tests. - The test project is
test/Microsoft.VisualStudio.SolutionPersistence.Tests/Microsoft.VisualStudio.SolutionPersistence.Tests.csproj; its managed targets arenet10.0and, on Windows,net472.
- Honor StyleCop rules and fix any reported build warnings after getting tests to pass.
- In C# files, use namespace statements instead of namespace blocks for all new files.
- Add API doc comments to all new public and internal members in shipping code under
src. Tests and samples do not require XML API documentation; do not add XML docs to test or sample members solely to satisfy this rule.