Skip to content

Commit

Permalink
Reflect updated workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnnapora authored Aug 6, 2019
1 parent 8b3b2f9 commit 5524177
Showing 1 changed file with 3 additions and 18 deletions.
21 changes: 3 additions & 18 deletions docs/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
- Do check in source (src)
- Do not check in build output (lib)
- Do not check in node_modules

0 comments on commit 5524177

Please sign in to comment.