From c57e58b1ee2ffdcfc34983c150a3bc10bd717cd8 Mon Sep 17 00:00:00 2001 From: Brian Cristante Date: Fri, 27 Dec 2019 11:28:48 -0500 Subject: [PATCH] Consistent file name references --- docs/contributors.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index 472a92a..0f2cfca 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -2,13 +2,13 @@ ### Checkin -- Do check in source (src) -- Do check in a single index.js file after running `ncc` -- Do not check in node_modules +- Do check in source (`src/`) +- Do check in a single `index.js` file after running `ncc` +- Do not check in `node_modules/` ### NCC -In order to avoid uploading `node_modules` to the repository, we use [zeit/ncc](https://github.com/zeit/ncc) to create a single `index.js` file that gets saved in `dist/`. +In order to avoid uploading `node_modules/` to the repository, we use [zeit/ncc](https://github.com/zeit/ncc) to create a single `index.js` file that gets saved in `dist/`. ### Developing @@ -18,7 +18,7 @@ npm install tsc ncc build ``` -Any files generated using `tsc` will be added to `lib/*`, however those files also are not uploaded to the repository and are exluded using `.gitignore`. +Any files generated using `tsc` will be added to `lib/`, however those files also are not uploaded to the repository and are exluded using `.gitignore`. During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier)