Contributing

Development

# install dependencies
npm i

# link the module into newman's node_modules
npm run local-dev

# call a test collection
npm test

If you update dependencies, you must re-run npm run local-dev.

The commit contains the following structural elements, to communicate intent to the consumers of your library:

fix: patch-level commit
docs: insufficent to trigger a release
feat: minor-level commit
types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.

The semantic-release plugin will make a new github release and upload the package to npm.

You'll need to be logged into npm and have a github token.

# interactive npm login
npm login

export GH_TOKEN=YOUR_GITHUB_TOKEN

npx semantic-release --no-ci

If the release plugin fails to upload to the npm registry, make sure two-factor auth is auth-only. You can check this with npm profile get.