From 9b08888d3b501e1f634a4b4612ed35c5d7bd7b5b Mon Sep 17 00:00:00 2001 From: Mikael Korpela Date: Tue, 8 Oct 2019 19:20:57 +0300 Subject: [PATCH] docs --- apps/README.md | 5 +++++ packages/README.md | 4 +++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/apps/README.md b/apps/README.md index c15bf8d870c81..e0eb4d8995c0a 100644 --- 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 index 845016e11cff9..e85d95363e6f1 100644 --- 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.