Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

77 lines (57 loc) · 2.9 KB

Contributing

Contributor Covenant

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.

Prerequisites

Build

Console

  1. Open your favorite console
  2. Navigate to the root of your local clone of this repository
  3. Execute the following command:
    dotnet build
    

Visual Studio

  1. Start Visual Studio
  2. Click Open a project or solution
  3. Navigate to the root of your local clone of this repository
  4. Select SystemUtilities.sln and click Open
  5. Under the Build menu, click Build Solution

Test

Console

  1. Open your favorite console
  2. Navigate to the root of your local clone of this repository
  3. Execute the following command:
    dotnet test
    

Visual Studio

  1. Start Visual Studio
  2. Click Open a project or solution
  3. Navigate to the root of your local clone of this repository
  4. Select SystemUtilities.sln and click Open
  5. Under the Test menu, click Run All Tests

Pull Requests

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()
        {
        }
    }
}