Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.07 KB
Raw

Contributing to @jscutlery/semver

Thank you for your contribution 🤗!

Guidelines

  • Commits follow the Angular commit convention
  • Features and bug fixes should be covered by test cases
  • Features should be documented in the README

Building and testing the library

# install dependencies
yarn install

# run the tests
yarn test

# build the library
yarn build

Using npm link or yarn link

In order to use the library locally on another project, you can use the npm|yarn link feature.

  1. Head to the built package and inform npm|yarn about it:
cd dist/packages/semver
yarn link # or npm link
  1. Go to your project and link the package:
yarn link @jscutlery/semver # or npm link @jscutlery/semver

If you want to try semver on an already existing workspace, you can clone the following repository @yjaaidi/semver-sandbox and run the following command to reset the git history: tools/reset.sh.