forked from approvals/Approvals.NodeJS
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
moved contributing into a contributing.md file
- Loading branch information
1 parent
1de1921
commit 5051f9f
Showing
2 changed files
with
23 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
## Contributing | ||
|
||
### Getting started. | ||
|
||
```bash | ||
git clone https://github.com/approvals/Approvals.NodeJS.git | ||
cd Approvals.NodeJS | ||
npm install | ||
npm install -g grunt | ||
grunt | ||
``` | ||
|
||
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/gruntjs/grunt). | ||
|
||
### Debugging the grunt tasks (on Windows) | ||
|
||
1. install [node_inspector](https://github.com/dannycoates/node-inspector) >`npm install -g node-inspector` | ||
2. run node_inspector >`node-inspector` | ||
3. type a 'debugger;' statement where you'd like to stop in the code. | ||
4. Now run the grunt task by specifying the following > `node --debug-brk C:\Users\{YourUserName}\AppData\Roaming\npm\node_modules\grunt\bin\grunt --force [grunt_task_here]` | ||
5. Open a webkit browser with the url printed in step 2 above. | ||
6. Happy bug hunting! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters