Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.24 KB

contributing.md

File metadata and controls

36 lines (25 loc) · 1.24 KB
Raw

Contribution Guideline

Contributions are welcome. Before sending a pull request

  • Conform to the projects code style: 2 spaces for indention. See .editorconfig
  • Add tests for what you changed/added/fixed.
  • Don't let code coverage drop - run npm run cover to see current code coverage.
  • Update README.md to document your changes.

Install dependencies

npm install

Test

npm test

Coverage

npm run cover

Lint

npm run lint

Release

Restify-Mongoose uses the module npm-release as described below for releases. It will bump version in package.json and release new version to git and npm.

Remember to update CHANGELOG.md before release.

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

The command above enforce the use of semantic versions 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.