Rough outlines for new documentation/guides. R2

This commit is contained in:
rwaldron 2022-02-11 10:41:49 -05:00
parent 3d6a4a2c15
commit bb0544c02f
1 changed files with 60 additions and 2 deletions

View File

@ -14,6 +14,64 @@ Rough outline...
- don't mention any other frontmatter - don't mention any other frontmatter
- test code - test code
- assert api - assert api
- Write a test - Let's write a test, end to end.
- Run your test (links to Running-Tests.md) - Pre-work
- Find something that needs to be tested
- Read spec
- Create test plan
- This can be a super minimal version of the usual test plans, but will help to show how we work
- Write a checklist (we'll give a 2-3 point example to work from)
- Does it need a new feature tag?
- Share test plan
- Writing our first test
- Git stuff
- Pull test272 repo
- Create a branch
- What else?
- Create a new file
- Where? Why?
- What do I name it? Why?
- Copyright
- Link to https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#copyright
- Give example
- Frontmatter
- What goes here? Why?
- Link to https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#copyright
- Always required
- [`esid`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#esid)
- Show examples
- [`description`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#description)
- Show examples
- Always required for async tests
- [`flags: [async]`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#flags)
- Link to examples
- Always required for module tests
- [`flags: [module]`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#flags)
- Link to examples
- Always required for stage 3 features
- [`features: [...]`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#features)
- Link to examples
- Always required if tests need additional test helper functionality
- [`includes: [...]`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#includes)
- Link to examples
- Always required for syntax tests that are intentionally expected to fail (More on this in a follow up guide)
- [`negative`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#negative)
- Give examples
- Helpful to have
- [`info`](https://github.com/tc39/test262/blob/main/CONTRIBUTING.md#info)
- Give examples
- Link to examples
- Body
- Show examples "good", "better", "best"
- Run our test
- Links to Running-Tests.md
- Shows minimal run example, ie. "If we've already read Running-Tests.md and set up a test running environment, go ahead and execute this command..."
- What else could be tested?
- Commit code
- Push branch
- Open PR
- Ask for review
- Who?
- We need a list of people that will likely respond