Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 963 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 963 Bytes

Contributing

Browser Bunyan uses Lerna for managing its core and stream packages and share dependencies.

Each package can be found in the ./packages directory. Build and test all packages from the root directory by running npm bootstrap and npm run test from the root directory respectively.

npm i
npm run bootstrap
npm run test

Builds

 cd packages/<package-name>
 npm run build

Each package uses microbundle to create ESM, CJS and UMD builds.

Test

 cd packages/<package-name>
 npm test

Test are written using Tap

You can manually test the UMD build by opening ./examples/index.html in a browser and inspecting the console.

Publish

Publish all udpdated packages to NPM:

npm run publish

(see @lerna/publish)