Files
externals/npm/node_modules/ts-jest/collaborator-guidelines.md
2020-05-28 11:53:18 -04:00

1.5 KiB

Table of Contents generated with DocToc

Collaborator Guidelines

Installing and building the project

To be able to install and build the project probably, rimraf is required. Install rimraf by running

yarn global add rimraf

After installing rimraf, yarn command can be run normally when installing dependencies for the project

Merging PRs

  1. A PR should be merged when at least one of the following conditions is satisfied:
  • 2 collaborators have reviewed and okayed the PR
  • 1 collaborator has reviewed and okayed the PR and 36 hours have passed after the PR was submitted
  1. Collaborators should squash and merge PRs with a commit message explaining the changes.

  2. All PRs should add the author's name and email address to the authors file, if it isn't already present.

Versioning

ts-jest must match the major version of jest. Matching the minor version is preferred. Matching the version patch is not required.

When merging PRs which fix bugs, it is preferable to increment the version patch version so that the changes can be published to NPM.