Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 1.4 KB

Contributing to Lerna

To get started with the repo:

$ git clone [email protected]:lerna/lerna.git && cd lerna
$ npm install

Code Structure

Currently, the source is split up into a few categories:

  • Utilities: methods to run git, npm, fs, and more.
  • Abstractions for packages
  • Lerna Commands: each command has an initialize and execute function.

Commands

In order to run the tests:

$ npm test

Or the linter:

$ npm run lint

If you want to test out Lerna on local repos:

$ npm run build
$ npm link

This will set your global lerna command to the local version.

Note that Lerna needs to be built after changes are made. So you can either run npm run build to run it once, or you can run:

$ npm run dev

Which will start a watch task that will continuously re-build Lerna while you are working on it.

If you would like to check test coverage, run the coverage script, then open coverage/lcov-report/index.html in your favorite browser.

$ npm run coverage
$ xdg-open coverage/lcov-report/index.html