release.md

Release Guide

Please take a moment to review this document in order to make the update process easy and effective for everyone involved.

This package follows semantic versioning, which means breaking changes may occur between major releases.

Ensure code has been thoroughly linted and tested, see package.json and Makefile for available scripts.

Ensure all occurrences of version numbers, releases branch, and branch aliases reflect the new release of the plugin.

Notes

1. Add the new version and details of it to the CHANGELOG.md.
2. npm version <newversion> ---no-git-tag-version --workspaces — Build the distribution files.
3. Commit CHANGELOG.md, package-lock.json, and dist/package.json, and tag the repository.
4. npm publish --workspaces — Publish the distribution files to the NPM registry.

Node Version

1. .nvmrc
2. package.json:
   1. engines.node
3. README.md

Benchmarks

1. README.md#benchmarks
2. benchmarks/README.md

NPM Version

1. package.json:
   1. engines.npm

Package Version

1. package.json:
   1. version