CONTRIBUTING.md 1.19 KB

How to Contribute

Pull Requests

We also accept pull requests!

Generally we like to see pull requests that

  • Maintain the existing code style
  • Are focused on a single change (i.e. avoid large refactoring or style adjustments in untouched code if not the primary goal of the pull request)
  • Have good commit messages
  • Have tests
  • Don't decrease the current code coverage (see coverage/lcov-report/index.html)

Building

npm install
grunt

The grunt dev implements watching for tests within Node and karma start may be used for manual testing in browsers.

If you notice any problems, please report them to the GitHub issue tracker at http://github.com/kpdecker/jsdiff/issues.

Releasing

JsDiff utilizes the release yeoman generator to perform most release tasks.

A full release may be completed with the following:

yo release
npm publish
yo release:publish components jsdiff dist/components/