From 3ca3dc76ebf7fd6aabaf5ef050f035f01bb831e4 Mon Sep 17 00:00:00 2001 From: Danny McCormick <damccorm@microsoft.com> Date: Wed, 5 Jun 2019 16:30:36 -0400 Subject: [PATCH] Update docs --- .gitignore | 2 -- docs/contributors.md | 8 ++++---- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 8dbed9b3..75734808 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1 @@ -# runtime dependencies are checked in -# dev dependencies are *not* checked in __tests__/runner/* \ No newline at end of file diff --git a/docs/contributors.md b/docs/contributors.md index 708d9a7b..fece2ea2 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -1,6 +1,5 @@ # Contributors - ### Checkin - Do checkin source (src) @@ -8,9 +7,10 @@ - Do checkin runtime node_modules - Do not checkin devDependency node_modules (husky can help see below) -### Husky +### devDependencies -We run [Husky](https://github.com/typicode/husky) before each commit to ensure that formatting and checkin rules are followed. To make sure Husky runs correctly, please use the following workflow: +In order to handle correctly checking in node_modules without devDependencies, we run [Husky](https://github.com/typicode/husky) before each commit. +This step ensures that formatting and checkin rules are followed and that devDependencies are excluded. To make sure Husky runs correctly, please use the following workflow: ``` npm install # installs all devDependencies including Husky @@ -18,5 +18,5 @@ git add abc.ext # Add the files you've changed. This git commit -m "Informative commit message" # Commit. This will run Husky ``` -Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier) as well as pruning out devDependencies using `npm prune --production`. +During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier) as well as pruning out devDependencies using `npm prune --production`. It will also make sure these changes are appropriately included in your commit (no further work is needed) \ No newline at end of file