Reflect updated workflow
This commit is contained in:
parent
8b3b2f9d81
commit
552417765d
|
@ -3,20 +3,5 @@
|
||||||
### Checkin
|
### Checkin
|
||||||
|
|
||||||
- Do check in source (src)
|
- Do check in source (src)
|
||||||
- Do checkin build output (lib)
|
- Do not check in build output (lib)
|
||||||
- Do checkin runtime node_modules
|
- Do not check in 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)
|
|
||||||
|
|
Loading…
Reference in New Issue