Skip to main content

Contributing

We welcome issues and pull requests from the community. 💜

Issues​

Open an issue on the issue tracker.

Please include the following information:

  • Operating system
  • Node.js version
  • Jest version
  • jest-allure2-reporter version
  • Reproduction repository
  • Steps to reproduce

Pull requests​

Setup​

This is a standard Node.js project. You'll need to have Node.js installed.

Fork this repository, clone and install dependencies:

npm install

Running tests​

Generate fixtures:

npm run record

If you want to check compatiblity with a specific Jest version, you can use the JEST_VERSION environment variable:

JEST_VERSION=27 npm run record

Run tests:

npm test

To view the test results, regenerate the full version of the fixtures:

npm run start

If you want to check compatiblity with a specific Jest version, you can use the JEST_VERSION environment variable:

JEST_VERSION=27 npm run start

To re-run the Allure CLI server, run:

npm run serve

Checking your code​

Before committing, run the linter and tests:

npm run lint
npm test

To create a commit, use Commitizen:

npx cz

and follow the instructions. We adhere to Angular's commit message guidelines.

Thanks in advance for your contribution!