This project has adopted the code of conduct as defined by the Contributor Convenant organization. Please take time to review it before contributing to this project.
- Required: .NET SDK with a version that matches the global.json file. If in doubt, just install the version specified in the
$.sdk.version
field. Ensure that installation directory gets added to yourPATH
environment variable. - Recommended: Visual Studio 2022 (Windows only)
- Open your favorite console
- Navigate to the root of your local clone of this repository
- Execute the following command:
dotnet build
- Start Visual Studio
- Click
Open a project or solution
- Navigate to the root of your local clone of this repository
- Select
SystemUtilities.sln
and clickOpen
- Under the
Build
menu, clickBuild Solution
- Open your favorite console
- Navigate to the root of your local clone of this repository
- Execute the following command:
dotnet test
- Start Visual Studio
- Click
Open a project or solution
- Navigate to the root of your local clone of this repository
- Select
SystemUtilities.sln
and clickOpen
- Under the
Test
menu, clickRun All Tests
Pull requests welcome!
This project adheres to the principles of test-driven development. All pull requests should include one or more tests that demonstrate a bug or missing feature. They may also be paired with changes that fix/add the corresponding bug/feature.
All tests in main
should always pass. If you are contributing a test that fails (e.g. to demostrate a bug), you must mark it with one of the following test categories:
Failure Reason | Test Category |
---|---|
Demonstrates a bug | Bug |
Demonstrates a mising feature | FeatureRequest |
For example, to mark a test that demonstrates a bug in MSTest, use the TestCategory
attribute:
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace MSTestNamespace
{
[TestClass]
public class UnitTest1
{
[TestMethod, TestCategory("Bug")]
public void TestMethod1()
{
}
}
}