From 3d6a4a2c1503cdf81e7c6819969eda0de88b37c8 Mon Sep 17 00:00:00 2001 From: rwaldron Date: Thu, 10 Feb 2022 16:07:18 -0500 Subject: [PATCH] Rough outlines for new documentation/guides --- guides/Getting-Started.md | 19 +++++++++++++++++++ guides/Running-Tests.md | 14 ++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 guides/Getting-Started.md create mode 100644 guides/Running-Tests.md diff --git a/guides/Getting-Started.md b/guides/Getting-Started.md new file mode 100644 index 0000000000..c3f5e0b52a --- /dev/null +++ b/guides/Getting-Started.md @@ -0,0 +1,19 @@ +# Getting Started With Test262 + + +Rough outline... + + +- Why do we test? +- What do we test? + - Similar to https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#acceptable-tests and https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#unacceptable-tests +- Anatomy of a test + - frontmatter + - esid + - description + - don't mention any other frontmatter + - test code + - assert api +- Write a test +- Run your test (links to Running-Tests.md) + diff --git a/guides/Running-Tests.md b/guides/Running-Tests.md new file mode 100644 index 0000000000..1487fa7484 --- /dev/null +++ b/guides/Running-Tests.md @@ -0,0 +1,14 @@ +# Running Tests + +- Explain Test262-Harness + - Explain role of eshost + - Explain role of esvu +- How to set up Test262-Harness + - Borrow from https://github.com/bterlson/test262-harness#getting-started +- Provide a bunch of common and useful examples of test262-harness commands, with explanations of what is happening and what to expect + - Speeding up with threads + - Specifying engines-specific host args + - filtering tests with `--features` + - Polyfill injection with `--prelude` + - Code tranformation intermediary with `--transformer` + - Code preprocessing and outcome overide with `--preprocessor`