Setup

npm install -g coffee-script
npm install -g mocha
npm install

Contributing to Mongoose User Plugin

Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
- Please describe the issue you are experiencing, along with any associated stack trace.
- Please post code that reproduces the issue, the version of mongoose-user-plugin, node version, and mongodb version.
- The source of this project is written in coffeescript, therefore your bug reports should be written in coffeescript.
- In general, adding a "+1" comment to an existing issue does little to help get it resolved. A better way is to submit a well documented pull request with clean code and passing tests.

Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
Please describe a use case for it
it would be ideal to include test cases as well
In general, adding a "+1" comment to an existing issue does little to help get it resolved. A better way is to submit a well documented pull request with clean code and passing tests.

Before starting to write code, look for existing issues. That way you avoid working on something that might not be of interest or that has been addressed already in a different branch. You can create a new issue here.
- The source of this project is written in coffeescript, therefore your bug reports should be written in coffeescript.
Fork the repo or for small documentation changes, navigate to the source on github and click the Edit button.
Follow the general coding style of the rest of the project
Write tests and make sure they pass (tests are in the test directory).

Open a terminal and navigate to the root of the project
execute npm install to install the necessary dependencies
execute make test to run the tests (we're using mocha)
- or to execute a single test T="-g 'some regexp that matches the test description'" make test
- any mocha flags can be specified with T="..."