summaryrefslogtreecommitdiffstats
path: root/docs/testing.md
diff options
context:
space:
mode:
authorEmily Shaffer <emilyshaffer@google.com>2019-06-24 14:13:05 -0700
committerEmily Shaffer <emilyshaffer@google.com>2019-06-25 18:04:27 -0700
commita3a1cdc299fbeee366fee925dc08fa3eaf8b63f2 (patch)
tree25d92178316e98a266c64710e2322c3798c0b1e7 /docs/testing.md
parentb5248c957371de5a3dcb5d052007ad369afb6689 (diff)
downloadphosphor-host-ipmid-a3a1cdc299fbeee366fee925dc08fa3eaf8b63f2.tar.gz
phosphor-host-ipmid-a3a1cdc299fbeee366fee925dc08fa3eaf8b63f2.zip
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
Diffstat (limited to 'docs/testing.md')
-rw-r--r--docs/testing.md23
1 files changed, 23 insertions, 0 deletions
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
OpenPOWER on IntegriCloud