Skip to content
This repository has been archived by the owner on May 8, 2018. It is now read-only.

Commit

Permalink
add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wraithgar committed Mar 30, 2016
1 parent 1a9c352 commit c6e26c2
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing

When making a pull request for this repo, please make sure of a few things

- tests and linting should pass for you locally. We have CI tests that also enforce this.
- rebuild the shrinkwrap file if you're changing any dependencies.

## Rebuilding the shrinkwrap

Because of the differences beween npm versions 2 and 3, you will want to use npm 2. A shrinkwrap built under npm 2 will also work under npm 3. A shrinkwrap built under npm 3 will *not* work under npm 2.

The simplest way to build a new shrinkwrap is to start with an empty node_modules. Once you've done that and have made sure you're using npm 2:

```sh
$ npm install
$ npm run shrinkwrap
```

Note that it is `npm run shrinkwrap` not `npm shrinkwrap`. This is because we have a shrinkwrap script that not only runs the shrinkwrap itself but also runs `shrinkydink`, a post-processor that cleans out some unneeded info we don't want.

0 comments on commit c6e26c2

Please sign in to comment.