Skip to content

Commit

Permalink
Merge de107e3 into da833b8
Browse files Browse the repository at this point in the history
  • Loading branch information
ismarslomic committed Jul 4, 2015
2 parents da833b8 + de107e3 commit 2dde4b4
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,3 +264,6 @@ Also you can specify a custom model name like this:
var users = restifyMongoose(User, {outputFormat: 'json-api', modelName: 'admins'});
users.serve('/users', restifyServer);
```

# Contribute
Contribution welcome! Read the [contribution guideline](contributing.md) first.
34 changes: 34 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contribution Guideline

## Install dependencies
npm install
npm install -g npm-release
npm install -g istanbul
npm install coveralls
npm install mocha-lcov-reporter

## Test
npm test

## Coverage
npm run cover

## Lint
npm run lint

## Release
Use the `npm-release` module as described below. It will bump version in `package.json` and release new version in git and npm.

Remember to update [CHANGELOG.md](CHANGELOG.md) **before** release.

npm-release [<newversion> | major | minor | patch | build] -m "<release message>"


Command above enforce the use of [semantic versions](http://semver.org/) when releasing:

Given a version number MAJOR.MINOR.PATCH, increment the:

* **MAJOR** version when you make incompatible API changes,
* **MINOR** version when you add functionality in a backwards-compatible manner, and
* **PATCH** version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

0 comments on commit 2dde4b4

Please sign in to comment.