docs

Automattic · Oct 14, 2019 · 9b08888 · 9b08888
1 parent 562d998
commit 9b08888
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/apps/README.md b/apps/README.md
@@ -17,3 +17,8 @@ You must manually build apps by running:
 ```bash
 npx lerna run build --scope="@automattic/app-name"
 ```
+
+## Validating package.json
+Running `npm run lint:package-json` will lint all `package.json`'s under `./apps/**` based on [`npmpackagejsonlint.config.js`](../npmpackagejsonlint.config.js).
+
+If you need exceptions to linting rules, add them to overrides section in the config file.
diff --git a/packages/README.md b/packages/README.md
@@ -19,4 +19,6 @@ npx lerna run prepare --scope="@automattic/package-name"
 ```
 
 ## Validating package.json
-Running `npm run lint:package-json` will lint all package.json's under `./packages/**` based on [`npmpackagejsonlint.config.js`](../npmpackagejsonlint.config.js).
+Running `npm run lint:package-json` will lint all `package.json`'s under `./packages/**` based on [`npmpackagejsonlint.config.js`](../npmpackagejsonlint.config.js).
+
+If you need exceptions to linting rules, add them to overrides section in the config file.