How to Contribute

Pull Requests

We also accept [pull requests][pull-request]!

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

yarn
yarn test

Running yarn test -- dev will watch 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

A full release may be completed by first updating the "version" property in package.json, then running the following:

yarn clean
yarn grunt release
yarn publish

After releasing, remember to:

• commit the package.json change and push it to GitHub
• create a new version tag on GitHub
• update diff.js on the gh-pages branch to the latest built version from the dist/ folder.