Skip to content

Commit

Permalink
Merge pull request #1289 from rwaldron/readme-updates
Browse files Browse the repository at this point in the history
Readme updates
  • Loading branch information
leobalter authored Oct 17, 2017
2 parents 772fb79 + b537d40 commit 8837686
Showing 1 changed file with 31 additions and 8 deletions.
39 changes: 31 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,43 @@
## Test262 is the official ECMAScript (ECMA-262) conformance suite.
## Test262: ECMAScript Test Suite ([ECMA TR/104](http://ecma-international.org/publications/techreports/E-TR-104.htm))

Test262 tests conformance to the continually maintained draft future ECMAScript standard found at http://tc39.github.io/ecma262/ , together with any Stage 3 or later TC39 proposals. It is maintained by Tom Care (@tcare) and Leo Balter (@leobalter) with significant contributions from many in the ECMAScript community.

This project is also described by the [Ecma Technical Report 104](http://ecma-international.org/publications/techreports/E-TR-104.htm).
Test262 is the implementation conformance test suite for the latest drafts (or most recent published edition) of the following Ecma specifications:

- [ECMA-262, ECMAScript Language Specification](https://tc39.github.io/ecma262/)
- [ECMA-402, ECMAScript Internationalization API Specification](https://tc39.github.io/ecma402/)
- [ECMA-404, The JSON Data Interchange Format](https://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf) (pdf)

Test262 itself is described in [ECMA TR/104]((http://ecma-international.org/publications/techreports/E-TR-104.htm)) and is included in [ECMA-414](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-414.pdf) (pdf).

### Goals & State of Test262

The goal of Test262 is to provide test material that covers every observable behavior specified in the [ECMA-414 Standards Suite](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-414.pdf). Development of Test262 is an on-going process. As of October 2017, Test262 consisted of over 29272 individual test files covering the majority of the pseudo-code algorithms and grammar productions defined in the [ECMA-414 Standards Suite](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-414.pdf). Each of these files contains one or more distinct test cases. This marks the most comprehensive ECMAScript test suite to date. While test coverage is broad, TC39 does not consider coverage to be complete and as with any software project there exists the possibility of omissions and errors. This project welcomes any contributions to Test262 that help make test coverage of existing features more comprehensive.


### ECMAScript feature proposals

As defined in the [TC39 Process](https://tc39.github.io/process-document/), Stage 4 Entrance Criteria requires tests for new feature proposals to advance. Tests may be written by proposal champions, implementers, or any interested community member.

A **proposal champion** is someone that worked on the feature proposal and specification directly.

An **implementer** is someone that works on implementing the proposal into a JavaScript engine, parser, runtime or embedding.

A **community member** is _you_, and we welcome you to contribute! If you're having trouble getting started, or even just want to ask a question, feel free to open an issue.

### Contributing to Test262
> See [CONTRIBUTING.md](./CONTRIBUTING.md)

1. Sign the [Test262 CLA](http://tc39.github.io/test262-cla).
2. Send a pull request. Please make sure you have one commit per pull request. If you have multiple commits, squash them before sending the pull request.
Guidance for contributing to Test262 can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).

**Authors of contributions from non-Ecma member organizations must sign the [Test262 CLA](http://tc39.github.io/test262-cla)**

### Running Test262

> See [INTERPRETING.md](./INTERPRETING.md)
Guidance for running Test262 and explanations of how a test file is interpreted by a test runner is in [INTERPRETING](./INTERPRETING.md)


### Test262 Runners & Harnesses

There are a number of volunteer-maintained projects that may be used to execute Test262 in various ECMAScript hosts:
Volunteer-maintained projects that may be used to execute Test262 in various ECMAScript hosts:

- https://github.com/bterlson/test262-harness (platform: Node.js)
- https://github.com/test262-utils/test262-harness-py (platform: Python)
Expand Down

0 comments on commit 8837686

Please sign in to comment.