Skip to content

Commit

Permalink
moved contributing into a contributing.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
staxmanade committed Apr 16, 2013
1 parent 1de1921 commit 5051f9f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 23 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
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!

23 changes: 0 additions & 23 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,29 +47,6 @@ describe('And a Mocha sub-describe', function () {

Can you think any other testing frameworks should integrate with? Consider submitting a pull request, or report a Github issue for discussion.

## 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!

## Release History
_(Nothing yet)_

Expand Down

0 comments on commit 5051f9f

Please sign in to comment.