dotnet/runtime

Consolidate testing guidelines

Open

#10,557 opened on Jun 21, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C# (5,445 forks)batch import
area-Infrastructuredocumentationhelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

There are multiple documents under https://github.com/dotnet/coreclr/tree/master/Documentation/building that describe how testing can be accomplished. These docs include building and running tests. However since we are using platform agnostic tools, the instructions should also be largely agnostic of platform. Minor command line differences, but that are basically limited to use the .sh vs .cmd file. There is a Workflow section under Documentation that has a placeholder file for this type of information - RunningTests.md.

Contributor guide

Research direction
Review the existing testing documentation under Documentation/building, identify common patterns and platform specific differences, and consolidate them into a single RunningTests.md file under Documentation/workflow.
Tech stack
csharp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70