From 552417765d5566b258ffbad7505b6d45ad2dbe7d Mon Sep 17 00:00:00 2001 From: Shawn Napora <17864647+shawnnapora@users.noreply.github.com> Date: Tue, 6 Aug 2019 18:12:22 -0400 Subject: [PATCH] Reflect updated workflow --- docs/contributors.md | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index fece2ea2..e6b5f5aa 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -2,21 +2,6 @@ ### Checkin -- Do checkin source (src) -- Do checkin build output (lib) -- Do checkin runtime node_modules -- Do not checkin devDependency node_modules (husky can help see below) - -### devDependencies - -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 -git add abc.ext # Add the files you've changed. This should include files in src, lib, and node_modules (see above) -git commit -m "Informative commit message" # Commit. This will run Husky -``` - -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 +- Do check in source (src) +- Do not check in build output (lib) +- Do not check in node_modules