From f05cc8bd32bb5dda8a552fca05aee6e3df6e879c Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Mon, 27 Apr 2020 17:00:50 +0200 Subject: [PATCH 01/13] Create metadata.md --- metadata.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 metadata.md diff --git a/metadata.md b/metadata.md new file mode 100644 index 0000000000..79091414fb --- /dev/null +++ b/metadata.md @@ -0,0 +1,48 @@ +# Metadata +At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used to build the webpage, for example. +This is an example of this schema and does not represent a real test: +## Schema +```json +/*! +{ + "name": "JPEG 2000", + "property": "jpeg2000", + "tags": ["media", "attribute"], + "caniuse": "jpeg2000", + "authors": ["Markel Ferro (@MarkelFe)", "@rejas", "Brandom Aaron"], + "builderAliases": ["a_download"], + "polyfills": ["xaudiojs"], + "aliases": ["jpeg-2000", "jpg2"], + "async": true, + "warnings": ["These tests currently require document.body to be present"], + "knownBugs": ["This will false positive in IE6"], + "notes": [{ + "name": "Specification", + "href": "https://www.w3.org/" + }, { + "name": "Github issue", + "href": "https://github.com/Modernizr/" + }] +} +!*/ +/* DOC +Here it would go a description of the feature test. You can use **markdown** here :) +*/ +``` +> There is no set order in which they must appear, but it is common to see `name` and `property` at the top while `notes` at the bottom. + +## Item description +| | Necesity | Description | Notes | +|------------------|:--------:|:----------------------------------------------------:|:--------------------------------------------------:| +| `name` | required | Name of the feature detection | | +| `property` | required | The property name established in `Modernizr.addTest` | Preferably just lowercase, without any punctuation | +| `tags` | optional | | | +| `caniuse` | optional | | | +| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | +| `builderAliases` | optional | | | +| `polyfills` | optional | Available polyfills for not working versions | Add them in lib/polyfills.json | +| `aliases` | optional | Other names that the feature goes by | Used for search | +| `async` | optional | If the test supports async functionality | Defaults to false | +| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | +| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | +| `notes` | optional | Links to resources | | \ No newline at end of file From 8b613bc6ba073e58891f60b729e07fdfc95bba24 Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Mon, 27 Apr 2020 19:36:11 +0200 Subject: [PATCH 02/13] Update the table --- metadata.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/metadata.md b/metadata.md index 79091414fb..4774c7bae8 100644 --- a/metadata.md +++ b/metadata.md @@ -32,17 +32,17 @@ Here it would go a description of the feature test. You can use **markdown** her > There is no set order in which they must appear, but it is common to see `name` and `property` at the top while `notes` at the bottom. ## Item description -| | Necesity | Description | Notes | -|------------------|:--------:|:----------------------------------------------------:|:--------------------------------------------------:| -| `name` | required | Name of the feature detection | | -| `property` | required | The property name established in `Modernizr.addTest` | Preferably just lowercase, without any punctuation | -| `tags` | optional | | | -| `caniuse` | optional | | | -| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | -| `builderAliases` | optional | | | -| `polyfills` | optional | Available polyfills for not working versions | Add them in lib/polyfills.json | -| `aliases` | optional | Other names that the feature goes by | Used for search | -| `async` | optional | If the test supports async functionality | Defaults to false | -| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | -| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | -| `notes` | optional | Links to resources | | \ No newline at end of file +| | Necesity | Description | Notes | +|------------------|:--------:|:----------------------------------------------------:|:---------------------------------------------------------:| +| `name` | required | Name of the feature detection | | +| `property` | required | The property name established in `Modernizr.addTest` | Preferably just lowercase, without any punctuation | +| `tags` | optional | A group that encapsulates many feature detects | | +| `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to test/browser/integration/caniuse.js | +| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | +| `builderAliases` | optional | | | +| `polyfills` | optional | Available polyfills for not working versions | Add them in lib/polyfills.json | +| `aliases` | optional | Other names that the feature goes by | | +| `async` | optional | If the test supports async functionality | Defaults to false | +| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | +| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | +| `notes` | optional | Links to resources | | \ No newline at end of file From db85c73244b2a63e6525ecb5da67131fdf90f4ff Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Mon, 27 Apr 2020 19:46:59 +0200 Subject: [PATCH 03/13] Added builderAliases --- metadata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.md b/metadata.md index 4774c7bae8..5d6075bb0b 100644 --- a/metadata.md +++ b/metadata.md @@ -39,7 +39,7 @@ Here it would go a description of the feature test. You can use **markdown** her | `tags` | optional | A group that encapsulates many feature detects | | | `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to test/browser/integration/caniuse.js | | `authors` | optional | List of contributors of the script | There are a couple of ways to express it | -| `builderAliases` | optional | | | +| `builderAliases` | optional | Used by CI and the web when tests are renamed | | | `polyfills` | optional | Available polyfills for not working versions | Add them in lib/polyfills.json | | `aliases` | optional | Other names that the feature goes by | | | `async` | optional | If the test supports async functionality | Defaults to false | From fac9b86cfa293894e1539da88c202d24fbd729bf Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Mon, 27 Apr 2020 19:53:08 +0200 Subject: [PATCH 04/13] Updated aliases --- metadata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.md b/metadata.md index 5d6075bb0b..1e19b49854 100644 --- a/metadata.md +++ b/metadata.md @@ -41,7 +41,7 @@ Here it would go a description of the feature test. You can use **markdown** her | `authors` | optional | List of contributors of the script | There are a couple of ways to express it | | `builderAliases` | optional | Used by CI and the web when tests are renamed | | | `polyfills` | optional | Available polyfills for not working versions | Add them in lib/polyfills.json | -| `aliases` | optional | Other names that the feature goes by | | +| `aliases` | optional | Used if a feature has more than a canonical name | Should not be needed in new tests | | `async` | optional | If the test supports async functionality | Defaults to false | | `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | | `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | From 1bfbc59b32624a9e36e6f386f2ef958dc107cc9d Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Mon, 27 Apr 2020 20:39:05 +0200 Subject: [PATCH 05/13] Added relative links + should not mentions --- metadata.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/metadata.md b/metadata.md index 1e19b49854..0198586be9 100644 --- a/metadata.md +++ b/metadata.md @@ -1,6 +1,6 @@ # Metadata -At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used to build the webpage, for example. -This is an example of this schema and does not represent a real test: +At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used, for example, to build the webpage. +This is an example of this schema (it does not represent a real test): ## Schema ```json /*! @@ -32,17 +32,17 @@ Here it would go a description of the feature test. You can use **markdown** her > There is no set order in which they must appear, but it is common to see `name` and `property` at the top while `notes` at the bottom. ## Item description -| | Necesity | Description | Notes | -|------------------|:--------:|:----------------------------------------------------:|:---------------------------------------------------------:| -| `name` | required | Name of the feature detection | | -| `property` | required | The property name established in `Modernizr.addTest` | Preferably just lowercase, without any punctuation | -| `tags` | optional | A group that encapsulates many feature detects | | -| `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to test/browser/integration/caniuse.js | -| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | -| `builderAliases` | optional | Used by CI and the web when tests are renamed | | -| `polyfills` | optional | Available polyfills for not working versions | Add them in lib/polyfills.json | -| `aliases` | optional | Used if a feature has more than a canonical name | Should not be needed in new tests | -| `async` | optional | If the test supports async functionality | Defaults to false | -| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | -| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | -| `notes` | optional | Links to resources | | \ No newline at end of file +| | Necesity | Description | Notes | +|------------------|:--------:|:----------------------------------------------------:|:-----------------------------------------------------------------------:| +| `name` | required | Name of the feature detection | | +| `property` | required | The property name established in `Modernizr.addTest` | Preferably just lowercase, without any punctuation | +| `tags` | optional | A group that encapsulates many feature detects | | +| `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to [caniuse.js](test/browser/integration/caniuse.js) | +| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | +| `builderAliases` | optional | Used by CI and the web when tests are renamed | Should not be needed in new tests | +| `polyfills` | optional | Available polyfills for not working versions | Add them in [polyfills.json](lib/polyfills.json) | +| `aliases` | optional | Used if a feature has more than a canonical name | Should not be needed in new tests | +| `async` | optional | If the test supports async functionality | Defaults to false | +| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | +| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | +| `notes` | optional | Links to resources | | \ No newline at end of file From 0b065dc4a97b5997206092371673db350100a681 Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Mon, 27 Apr 2020 21:22:39 +0200 Subject: [PATCH 06/13] Notes edits --- metadata.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/metadata.md b/metadata.md index 0198586be9..e751c3da7f 100644 --- a/metadata.md +++ b/metadata.md @@ -32,17 +32,17 @@ Here it would go a description of the feature test. You can use **markdown** her > There is no set order in which they must appear, but it is common to see `name` and `property` at the top while `notes` at the bottom. ## Item description -| | Necesity | Description | Notes | -|------------------|:--------:|:----------------------------------------------------:|:-----------------------------------------------------------------------:| -| `name` | required | Name of the feature detection | | -| `property` | required | The property name established in `Modernizr.addTest` | Preferably just lowercase, without any punctuation | -| `tags` | optional | A group that encapsulates many feature detects | | -| `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to [caniuse.js](test/browser/integration/caniuse.js) | -| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | -| `builderAliases` | optional | Used by CI and the web when tests are renamed | Should not be needed in new tests | -| `polyfills` | optional | Available polyfills for not working versions | Add them in [polyfills.json](lib/polyfills.json) | -| `aliases` | optional | Used if a feature has more than a canonical name | Should not be needed in new tests | -| `async` | optional | If the test supports async functionality | Defaults to false | -| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | -| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | -| `notes` | optional | Links to resources | | \ No newline at end of file +| | Necesity | Description | Notes | +|------------------|:--------:|:----------------------------------------------------:|:--------------------------------------------------------------------------------:| +| `name` | required | Name of the feature detection | | +| `property` | required | The property name established in `Modernizr.addTest` | It must be lowercase, without any punctuation | +| `tags` | optional | A group that encapsulates many feature detects | | +| `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to [caniuse.js](test/browser/integration/caniuse.js) | +| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | +| `builderAliases` | optional | Used by CI and the web when tests are renamed | Should not be needed in new tests | +| `polyfills` | optional | Available polyfills for not working versions | Any polyfill listed needs to be included in [polyfills.json](lib/polyfills.json) | +| `aliases` | optional | Used if a feature has more than a canonical name | Legacy only - do not use | +| `async` | optional | If the test supports async functionality | Defaults to false | +| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | +| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | +| `notes` | optional | Links to resources | | \ No newline at end of file From a65cbad93b01061378058e912b0206f57aa24437 Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Tue, 28 Apr 2020 11:56:21 +0200 Subject: [PATCH 07/13] Remove authors note --- metadata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.md b/metadata.md index e751c3da7f..6619794e5d 100644 --- a/metadata.md +++ b/metadata.md @@ -38,7 +38,7 @@ Here it would go a description of the feature test. You can use **markdown** her | `property` | required | The property name established in `Modernizr.addTest` | It must be lowercase, without any punctuation | | `tags` | optional | A group that encapsulates many feature detects | | | `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to [caniuse.js](test/browser/integration/caniuse.js) | -| `authors` | optional | List of contributors of the script | There are a couple of ways to express it | +| `authors` | optional | List of contributors of the script | | | `builderAliases` | optional | Used by CI and the web when tests are renamed | Should not be needed in new tests | | `polyfills` | optional | Available polyfills for not working versions | Any polyfill listed needs to be included in [polyfills.json](lib/polyfills.json) | | `aliases` | optional | Used if a feature has more than a canonical name | Legacy only - do not use | From 200dd4dc4a2af6a98e8978b1e81cb099d94188a0 Mon Sep 17 00:00:00 2001 From: Markel F Date: Tue, 28 Apr 2020 18:18:42 +0200 Subject: [PATCH 08/13] Rename file Also changed the header levels to accomodate the new title/purpose --- metadata.md => HOW_TO_WRITE_FEATURE_DETECTS.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) rename metadata.md => HOW_TO_WRITE_FEATURE_DETECTS.md (97%) diff --git a/metadata.md b/HOW_TO_WRITE_FEATURE_DETECTS.md similarity index 97% rename from metadata.md rename to HOW_TO_WRITE_FEATURE_DETECTS.md index 6619794e5d..971736fb0b 100644 --- a/metadata.md +++ b/HOW_TO_WRITE_FEATURE_DETECTS.md @@ -1,7 +1,7 @@ -# Metadata +## Metadata At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used, for example, to build the webpage. This is an example of this schema (it does not represent a real test): -## Schema +### Schema ```json /*! { @@ -31,7 +31,7 @@ Here it would go a description of the feature test. You can use **markdown** her ``` > There is no set order in which they must appear, but it is common to see `name` and `property` at the top while `notes` at the bottom. -## Item description +### Item description | | Necesity | Description | Notes | |------------------|:--------:|:----------------------------------------------------:|:--------------------------------------------------------------------------------:| | `name` | required | Name of the feature detection | | @@ -45,4 +45,4 @@ Here it would go a description of the feature test. You can use **markdown** her | `async` | optional | If the test supports async functionality | Defaults to false | | `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | | `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | -| `notes` | optional | Links to resources | | \ No newline at end of file +| `notes` | optional | Links to resources | | From 98005b1475289bdc1487b18301bb729a00443fc9 Mon Sep 17 00:00:00 2001 From: Markel F <45839898+MarkelFe@users.noreply.github.com> Date: Tue, 28 Apr 2020 19:07:14 +0200 Subject: [PATCH 09/13] Added introduction --- HOW_TO_WRITE_FEATURE_DETECTS.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/HOW_TO_WRITE_FEATURE_DETECTS.md b/HOW_TO_WRITE_FEATURE_DETECTS.md index 971736fb0b..6aebce0958 100644 --- a/HOW_TO_WRITE_FEATURE_DETECTS.md +++ b/HOW_TO_WRITE_FEATURE_DETECTS.md @@ -1,3 +1,10 @@ +# How to Write Feature Detects +The scope of this file is to help you to create new feature detects or edit existing ones. Here you will find details and guidelines that will help you understand how +Modernizr works. + +#### Table of contents +[Metadata](#metadata) + ## Metadata At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used, for example, to build the webpage. This is an example of this schema (it does not represent a real test): @@ -45,4 +52,4 @@ Here it would go a description of the feature test. You can use **markdown** her | `async` | optional | If the test supports async functionality | Defaults to false | | `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | | `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | -| `notes` | optional | Links to resources | | +| `notes` | optional | Links to resources | | \ No newline at end of file From 73d0ac0a2ec79933b00643fa91e1e803e40a0e76 Mon Sep 17 00:00:00 2001 From: Markel F Date: Tue, 28 Apr 2020 19:13:01 +0200 Subject: [PATCH 10/13] Revert "Added introduction" This reverts commit 98005b1475289bdc1487b18301bb729a00443fc9. --- HOW_TO_WRITE_FEATURE_DETECTS.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/HOW_TO_WRITE_FEATURE_DETECTS.md b/HOW_TO_WRITE_FEATURE_DETECTS.md index 6aebce0958..971736fb0b 100644 --- a/HOW_TO_WRITE_FEATURE_DETECTS.md +++ b/HOW_TO_WRITE_FEATURE_DETECTS.md @@ -1,10 +1,3 @@ -# How to Write Feature Detects -The scope of this file is to help you to create new feature detects or edit existing ones. Here you will find details and guidelines that will help you understand how -Modernizr works. - -#### Table of contents -[Metadata](#metadata) - ## Metadata At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used, for example, to build the webpage. This is an example of this schema (it does not represent a real test): @@ -52,4 +45,4 @@ Here it would go a description of the feature test. You can use **markdown** her | `async` | optional | If the test supports async functionality | Defaults to false | | `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | | `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | -| `notes` | optional | Links to resources | | \ No newline at end of file +| `notes` | optional | Links to resources | | From 146e0b75bcc6ee4a74d54188da8b2afedb8fdbed Mon Sep 17 00:00:00 2001 From: Markel F Date: Tue, 28 Apr 2020 19:14:42 +0200 Subject: [PATCH 11/13] Sorry, signature problems --- HOW_TO_WRITE_FEATURE_DETECTS.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/HOW_TO_WRITE_FEATURE_DETECTS.md b/HOW_TO_WRITE_FEATURE_DETECTS.md index 971736fb0b..ca7013afe9 100644 --- a/HOW_TO_WRITE_FEATURE_DETECTS.md +++ b/HOW_TO_WRITE_FEATURE_DETECTS.md @@ -1,3 +1,10 @@ +# How to Write Feature Detects +The scope of this file is to help you to create new feature detects or edit existing ones. Here you will find details and guidelines that will help you understand how +Modernizr works. + +#### Table of contents +[Metadata](#metadata) + ## Metadata At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used, for example, to build the webpage. This is an example of this schema (it does not represent a real test): From 00c78fd05a61d7382fac26bf4a5cae9484fa5cc4 Mon Sep 17 00:00:00 2001 From: Markel F Date: Tue, 5 May 2020 14:30:20 +0200 Subject: [PATCH 12/13] Make some sentences a little bit more clear --- HOW_TO_WRITE_FEATURE_DETECTS.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/HOW_TO_WRITE_FEATURE_DETECTS.md b/HOW_TO_WRITE_FEATURE_DETECTS.md index ca7013afe9..80522b1687 100644 --- a/HOW_TO_WRITE_FEATURE_DETECTS.md +++ b/HOW_TO_WRITE_FEATURE_DETECTS.md @@ -6,19 +6,19 @@ Modernizr works. [Metadata](#metadata) ## Metadata -At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used, for example, to build the webpage. -This is an example of this schema (it does not represent a real test): +A JSON fragment at the top of every feature detect in Modernizr represents the metadata of the test. This data is used, for example, to build the webpage. ### Schema +The following code represents an example of the schema (it does not represent a real test): ```json /*! { "name": "JPEG 2000", "property": "jpeg2000", - "tags": ["media", "attribute"], + "tags": ["media", "image"], "caniuse": "jpeg2000", "authors": ["Markel Ferro (@MarkelFe)", "@rejas", "Brandom Aaron"], - "builderAliases": ["a_download"], - "polyfills": ["xaudiojs"], + "builderAliases": ["jpeg2"], + "polyfills": ["jpeg2000js"], "aliases": ["jpeg-2000", "jpg2"], "async": true, "warnings": ["These tests currently require document.body to be present"], @@ -36,7 +36,7 @@ This is an example of this schema (it does not represent a real test): Here it would go a description of the feature test. You can use **markdown** here :) */ ``` -> There is no set order in which they must appear, but it is common to see `name` and `property` at the top while `notes` at the bottom. +> Metadata does no need to appear in a set order, however, it is common to see `name` and `property` at the top while `notes` at the bottom. ### Item description | | Necesity | Description | Notes | From 610fbbc6cc0e61316e9210dac82bf9ba351ed64f Mon Sep 17 00:00:00 2001 From: Markel F Date: Tue, 12 May 2020 14:36:17 +0200 Subject: [PATCH 13/13] Solve necessity typo --- HOW_TO_WRITE_FEATURE_DETECTS.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/HOW_TO_WRITE_FEATURE_DETECTS.md b/HOW_TO_WRITE_FEATURE_DETECTS.md index 80522b1687..b81c4a9a75 100644 --- a/HOW_TO_WRITE_FEATURE_DETECTS.md +++ b/HOW_TO_WRITE_FEATURE_DETECTS.md @@ -39,17 +39,17 @@ Here it would go a description of the feature test. You can use **markdown** her > Metadata does no need to appear in a set order, however, it is common to see `name` and `property` at the top while `notes` at the bottom. ### Item description -| | Necesity | Description | Notes | -|------------------|:--------:|:----------------------------------------------------:|:--------------------------------------------------------------------------------:| -| `name` | required | Name of the feature detection | | -| `property` | required | The property name established in `Modernizr.addTest` | It must be lowercase, without any punctuation | -| `tags` | optional | A group that encapsulates many feature detects | | -| `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to [caniuse.js](test/browser/integration/caniuse.js) | -| `authors` | optional | List of contributors of the script | | -| `builderAliases` | optional | Used by CI and the web when tests are renamed | Should not be needed in new tests | -| `polyfills` | optional | Available polyfills for not working versions | Any polyfill listed needs to be included in [polyfills.json](lib/polyfills.json) | -| `aliases` | optional | Used if a feature has more than a canonical name | Legacy only - do not use | -| `async` | optional | If the test supports async functionality | Defaults to false | -| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | -| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | -| `notes` | optional | Links to resources | | +| | Necessity | Description | Notes | +|------------------|:---------:|:----------------------------------------------------:|:--------------------------------------------------------------------------------:| +| `name` | required | Name of the feature detection | | +| `property` | required | The property name established in `Modernizr.addTest` | It must be lowercase, without any punctuation | +| `tags` | optional | A group that encapsulates many feature detects | | +| `caniuse` | optional | A conversion table of caniuse and Modernizr | Consider adding it to [caniuse.js](test/browser/integration/caniuse.js) | +| `authors` | optional | List of contributors of the script | | +| `builderAliases` | optional | Used by CI and the web when tests are renamed | Should not be needed in new tests | +| `polyfills` | optional | Available polyfills for not working versions | Any polyfill listed needs to be included in [polyfills.json](lib/polyfills.json) | +| `aliases` | optional | Used if a feature has more than a canonical name | Legacy only - do not use | +| `async` | optional | If the test supports async functionality | Defaults to false | +| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs | +| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | | +| `notes` | optional | Links to resources | |