Add contributor's guide #69
Conversation
| As a convenience it is possible to regenerate the expected output from the | ||
| actual output. This is useful when creating new tests and also when making a | ||
| change that affects multiple existing tests. To run use | ||
| `npm test -- --save-output`. Note that all tests will automatically pass when |
There was a problem hiding this comment.
Not a typo. Allows arguments to be passed to the executing script. See https://docs.npmjs.com/cli/run-script
|
nice 😎 |
|
Looks good! |
|
|
||
| To build from source you first need to `npm install`. You will also need a | ||
| version of TypeScript available, either globally or install locally with | ||
| `npm install typescript`. Then run `node build`. |
There was a problem hiding this comment.
I'd simply this and make typescript a dev dependency. Then add an npm script for building the project. Here's my normal set up: https://github.com/blakeembrey/typescript-simple-loader/blob/master/package.json#L15-L21
There was a problem hiding this comment.
Yea I'm good with changing to npm run build. I considered doing that originally. Not sure why I didn't. Regarding the dev dependency, that would probably work as long as it doesn't mess up the travis build.
|
Awesome 👍 |
jbrantly
force-pushed
the
contributing-guide
branch
from
50003db to
61b1636
Compare
|
Fixed the extensions issue. The other note regarding the build script I'll do as a separate PR. Thanks everyone. |
First pass at a contributor's guide. Does this make sense? Anything confusing or left out?