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

Latest commit

 

History

History
69 lines (48 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 1.34 KB

Contributing

Setting up a development environment

  1. Install node

    brew install node
    
  2. Install grunt

    npm install -g grunt
    
  3. Download the code

    git clone [email protected]:bugsnag/bugsnag-node
    
  4. Install the dependencies

    npm install
    

Testing

We use mocha to run the tests, but it's hooked up in package.json so that you can run

npm test

Releasing

If you're a member of the Bugsnag team.

Getting set up

  1. Set up a npm account
  2. Get someone to add you as a contributor on bugsnag-node
  3. npm adduser (put in your NPM login details, only do this once if your user isnt added)

Doing a release

  1. Update version in package.json.
  2. Update the version in lib/notifier.js
  3. Update the CHANGELOG.md
  4. Update the README if required
  5. grunt release
  6. npm publish

Update docs.bugsnag.com

Update the setup guides for JavaScript and CoffeeScript with Node with any new content.