From 7de0c72a57d210cd49713faebaab1db2d0f78fba Mon Sep 17 00:00:00 2001 From: Bryan MacFarlane Date: Sun, 15 Sep 2019 18:06:25 -0400 Subject: [PATCH] remove stale doc --- docs/contributors.md | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 docs/contributors.md diff --git a/docs/contributors.md b/docs/contributors.md deleted file mode 100644 index fece2ea..0000000 --- a/docs/contributors.md +++ /dev/null @@ -1,22 +0,0 @@ -# Contributors - -### 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