From a3a1cdc299fbeee366fee925dc08fa3eaf8b63f2 Mon Sep 17 00:00:00 2001 From: Emily Shaffer Date: Mon, 24 Jun 2019 14:13:05 -0700 Subject: docs: add initial testing.md outline Add a new piece of documentation, intended to be a tutorial on running, writing, and reviewing unit tests for the CI suite. Outline the sections to be written in some detail (subject to change). There are a handful of methods for running the CI, foremost by using Docker or by building the OpenBMC SDK. This tutorial will cover the Docker method, as it is most similar to what the Jenkins bot does, and most consistent across platforms. Tested: Viewed markdown file in Chrome. Change-Id: Ic98c02bc8f4dc6eaf4e7d1432422cdd934862548 --- docs/testing.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/testing.md (limited to 'docs') diff --git a/docs/testing.md b/docs/testing.md new file mode 100644 index 0000000..6f7bce4 --- /dev/null +++ b/docs/testing.md @@ -0,0 +1,23 @@ +# Running Tests + +## Setting Up Your Environment + +## Building + +## Running + +## Reading Output + +# Writing Tests + +## Setting Up Your Environment + +## Best Practices + +## Sending for Review + +# Reviewing Tests + +## Best Practices + +## Quickly Running At Home -- cgit v1.2.1