actions/setup-node
1
0
Fork 0
mirror of https://github.com/actions/setup-node.git synced 2025-04-03 01:49:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Danny McCormick 2019-06-05 16:30:36 -04:00
parent aa49102c9c
commit 3ca3dc76eb
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,3 +1 @@
# runtime dependencies are checked in
# dev dependencies are *not* checked in
__tests__/runner/*

8
docs/contributors.md
View File

@ -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)