update CONTRIBUTING.md

zloirock · Dec 26, 2018 · d9909b7 · d9909b7
1 parent bb3d3b5
commit d9909b7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -76,3 +76,14 @@ and after that use this file:
 ```
 tests/promises-aplus.html
 ```
+
+## Updating `core-js-compat` data
+
+For updating `core-js-compat` data:
+
+- Clone `core-js` repo.
+- If you wanna add new data for a browser, run in this browser `tests/compat/index.html` and you will see which `core-js` modules required for this browser.
+- If you wanna add new data for Node.js, run in this browser `tests/compat/node-runner.js` in required Node.js version and you will see results in the console.
+- After getting this data, add it to `packages/core-js-compat/src/data.js`.
+- If you wanna add new mapping (for example, add a new iOS Safari version based on Safari or Node.js based on Chrome), add it to `packages/core-js-compat/src/mapping.js`.
+- Add a pull request to `core-js` repo.
diff --git a/packages/core-js-compat/README.md b/packages/core-js-compat/README.md
@@ -33,3 +33,5 @@ console.log(targets);
 }
 */
 ```
+
+If you want to add new / update data about modules required for target engines, [follow this instruction](../../CONTRIBUTING.md#updating-core-js-compat-data).
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,3 +33,5 @@ console.log(targets); @@
     }
     */
     ```
+    If you want to add new / update data about modules required for target engines, [follow this instruction](../../CONTRIBUTING.md#updating-core-js-compat-data).