Skip to content

Files

Latest commit

 

History

History
42 lines (29 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.46 KB

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 and testing

yarn
yarn test

To run tests in a browser (for instance to test compatibility with Firefox, with Safari, or with old browser versions), run yarn karma start, then open http://localhost:9876/ in the browser you want to test in. Results of the test run will appear in the terminal where yarn karma start is running.

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

Releasing

Run a test in Firefox via the procedure above before releasing.

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

yarn clean
yarn build
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.