From cb754d2450d682afc25c6d263cb2a7ff17862a7d Mon Sep 17 00:00:00 2001 From: Leonardo Balter Date: Thu, 28 Jan 2016 15:55:50 -0500 Subject: [PATCH] Document frontmatter's id tag Fixes #477 --- CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 042a9f633c..d65a593d5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,6 +45,7 @@ Test262 supports the following tags: - [**negative**](#negative) - [**es5id**](#es5id) - [**es6id**](#es6id) + - [**id**](#id) - [**includes**](#includes) - [**timeout**](#timeout) - [**author**](#author) @@ -80,14 +81,21 @@ For best practices on how to use the negative tag please see Handling Errors and #### es5id **es5id**: [es5-test-id] -This tag identifies the portion of the ECMAScript 5.1 standard that is tested by this test. It was automatically generated for tests that were originally written for the ES5 version of the test suite and are now part of the ES6 version. +This tag identifies the section number from the portion of the ECMAScript 5.1 standard that is tested by this test. It was automatically generated for tests that were originally written for the ES5 version of the test suite and are now part of the ES6 version. When writing a new test for ES6, it is only necessary to include this tag when the test covers a part of the ES5 spec that is incorporated into ES6. All other tests should specify the `es6id` (see below) instead. #### es6id **es6id**: [es6-test-id] -This tag identifies the portion of the ECMAScript 6 standard that is tested by this test. +This tag identifies the section number from the portion of the ECMAScript 6 standard that is tested by this test. + +#### id +**id**: [spec-id] + +This tag identifies the hash id from the portion of the ECMAScript draft which is most recent to the date the test was added. It represents the anchors on the generated HTML version of the specs. E.g.: `id: sec-typedarray-length`. This tag might be used to replace a `es6id` or further. + +When writing a new test for a Stage 3+ spec not yet published on the draft, the `pending` value can be used while a hash id is not available. #### includes **includes**: [file-list]