Rough outlines for new documentation/guides

This commit is contained in:
rwaldron 2022-02-10 16:07:18 -05:00
parent df873eed1a
commit 3d6a4a2c15
2 changed files with 33 additions and 0 deletions

19
guides/Getting-Started.md Normal file
View File

@ -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)

14
guides/Running-Tests.md Normal file
View File

@ -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`