Browse Source

update docs and formatting

Steven Silvester 6 years ago
parent
commit
3036c8af12

+ 3 - 2
CONTRIBUTING.md

@@ -364,8 +364,9 @@ a package by importing from it in the TypeScript file, and then running:
 
 We also have scripts for creating and removing packages in `packages/`,
 `jlpm run create:package` and `jlpm run remove:package`. When creating a package,
-if it is meant to be included in the core bundle, add the `jupyterlab: { core: true }`
-metadata to the `package.json`.
+if it is meant to be included in the core bundle, add the `jupyterlab: { coreDependency: true }`
+metadata to the `package.json`. Packages with `extension` or `mimeExtension` metadata
+are considered to be a core dependency unless they are explicitly marked otherwise.
 
 ## Testing Changes to External Packages
 

+ 3 - 3
packages/application/package.json

@@ -54,10 +54,10 @@
     "typedoc": "^0.14.2",
     "typescript": "~3.4.3"
   },
-  "jupyterlab": {
-    "coreDependency": true
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "jupyterlab": {
+    "coreDependency": true
   }
 }

+ 3 - 3
packages/attachments/package.json

@@ -43,10 +43,10 @@
     "typedoc": "^0.14.2",
     "typescript": "~3.4.3"
   },
-  "jupyterlab": {
-    "coreDependency": false
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "jupyterlab": {
+    "coreDependency": false
   }
 }

+ 3 - 3
packages/cells/package.json

@@ -54,10 +54,10 @@
     "typedoc": "^0.14.2",
     "typescript": "~3.4.3"
   },
-  "jupyterlab": {
-    "coreDependency": false
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "jupyterlab": {
+    "coreDependency": false
   }
 }

+ 3 - 3
packages/codeeditor/package.json

@@ -45,10 +45,10 @@
     "typedoc": "^0.14.2",
     "typescript": "~3.4.3"
   },
-  "jupyterlab": {
-    "coreDependency": false
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "jupyterlab": {
+    "coreDependency": false
   }
 }