Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,16 @@ There are different types of replacements available:

When using the `documented` type, you should generally follow these guidelines:

- The mapping should have a `url` which points to an e18e documentation page (i.e. those in the [modules](https://github.com/es-tooling/module-replacements/tree/main/docs/modules) directory of the repo) which describes the replacement and how to migrate to it.
- The mapping should have a `url` which points to an e18e documentation page (i.e. those in the [modules](https://github.com/es-tooling/module-replacements/tree/main/docs/modules) directory of the repo) which describes the replacement and how to migrate to it. Documentation here will be automatically synced weekly to the e18e website.
- The replacement does not necessarily need a `url` itself
- The replacement does not need a `description`

When using the `native` type:

- The mapping generally does not need a `url`
- The replacement should have a `url` to its external documentation (e.g. MDN or Node docs)
- The replacement should have a `webFeatureId` if it is a web standard (these come from the [`web-features` dataset](https://github.com/web-platform-dx/web-features/tree/main/features))
- The replacement should have a `nodeFeatureId` if it is a Node built-in (these are of the form `{ moduleName: string, exportName?: string }`. For example, `fs` would be `{"moduleName": "fs"}`, while `fs.readFile` would be `{"moduleName": "fs", "exportName": "readFile"}`)
- If it's a web standard, then the replacement should have a `webFeatureId` (these come from the [`web-features` dataset](https://github.com/web-platform-dx/web-features/tree/main/features)), and a `url` to MDN
- If it's a Node built-in, then the replacement should have a `nodeFeatureId` (these are of the form `{ moduleName: string, exportName?: string }`. For example, `fs` would be `{"moduleName": "fs"}`, while `fs.readFile` would be `{"moduleName": "fs", "exportName": "readFile"}`), and a `url` to the Node docs

When using the `simple` type:

Expand Down