CONTRIBUTING.md

Contributing

Local Version Management

This package uses Volta to manage the Node and Yarn versions to run against. You don't have to use it, but that's how the versions will be set in the CI environment.

Conventional Commits

Each commit should follow the Conventional Commits pattern, so that we can use tools that automatically generate a CHANGELOG for us.

Running Tests

Since this package is an integration for QUnit, the tests are written using that library. Tests and a formatting check are both run using GitHub Actions for any commit pushed to GitHub.

To run the tests locally, you can run

yarn build
yarn test

Note that the tests are run against the compiled output, so the package must be built before performing the tests.

Publishing a Version

This project uses standard-version to leverage the Git history to find updates since the last version, determine the next version, and generate the CHANGELOG for us.

To create a new release, run the following:

yarn release --dry-run

And make sure that the version number and CHANGELOG look correct. Assuming they do, you can run

# Create and push release to GitHub
yarn release
git push --follow-tags origin master

# Build NPM package and push to registry
yarn build
npm publish

Once complete, copy the recent CHANGELOG entry into the notes of the new release on GitHub.