Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.75 KB

CONTRIBUTE.md

File metadata and controls

47 lines (35 loc) · 1.75 KB

Contribuion

Develop the libs alongside your project

  1. Download MIOJSLibs into your machine.

  2. Link the miojslibs package to your local global npm. Navigate to MIOJSLibs folder and run npm link. (more info).

    cd path-to-miojslibs/packages/miojslibs #depending on which platform do you want to develop
npm link

  3. Link miojslibs package to your project from your local global npm.

    This will create a symlink from your project's node_modules folder to the MIOJSLibs project folder.

    cd path-to-project
npm link miojslibs

  4. From now on if you rebuild the MIOJSLibs project the generated files will be seen by your app.

When you don't need the link anymore you can unlink the miojslibs from this repository. But this removes the folder from node_modules, and package.json so you have to install it again from npm.

npm unlink miojslibs
npm install miojslibs

Publish to npm

Docs.

In order to keep track of versions for multiple platforms, we use lerna. It is installed as a dev dependency It lets you run commands simultaneously in all packages, and can keep the versions in sync.

# Log in with the authenticated user: npm adduser
# Add changes to git if any. Eg: git add . && git commit -m 'New build'
npm version <update_type: patch, minor, major>
npm run prod
# Check the files that you are about to publish: npm pack
npm run publish # this calls lerna publish in all packages.