Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 1.56 KB

Contributing

First, ensure you have

  • Yarn ^1.21.1
  • node ^10.13.0
  • npm ^6.4.1
  • npx

To get started with the repo:

$ git clone [email protected]:Stinkstudios/npm-packages.git && cd npm-packages
$ yarn install

This is a monorepo utilising Lerna and Yarn Workspaces

Committing

Commit messages are linted with commitlint and follows Conventional Commits so Lerna can automatically update the CHANGELOG.md for each package on a release.

Commands

Run Unit Tests

$ yarn test

Linting

$ yarn lint

Code Format

$ yarn format

Releasing

To release a new version of a package you will need a NPM account and be part of Stink Studios organisation on NPM . All packages are scoped to @stinkstudios.

$ yarn
$ npm login
$ npx lerna publish

Add a new package

$ npx lerna create @stinkstudios/<your package name>

This will add a folder in packages

See Lerna create docs