$PACKAGE_NAME

$PACKAGE_NAME npm package.

Master

Dev

Table of Contents

• Changelog
• How it work
• Installation
• Reminders
• Quick start
• Release
• License

Changelog

• View Changelog

How it work

• Todo: write how it work !

Installation

npm install:

npm install git+$CI_REPOSITORY_URL

Reminders

⚠️ When using this plugin, you must import in the first line of your application javascript entry file babel-polyfill: ⚠️

import "babel-polyfill";

To enable ES features in older browsers, you MUST include in the package.json

"browserslist": ["ie >= 9", "last 2 versions"]
// or
"browserslist": ["ie >= 10", "last 2 versions"]

Quick start

Clone project

git clone $GIT_URL

Install dependencies

npm install

Build project

npm run build

Run unit test

npm test

Watch unit test

npm run test:watch

Watch the /dist directory

npm run build:dist:watch

Watch the /lib directory

npm run build:lib:watch

Contribute

master is used to release the version.

• master only accept merge requests from dev

dev is the developement branch. It should be used by developers for applying their merge requests.

If you wish to implement new features you need to do a merge request including your change on the dev branch.

git checkout dev
git checkout -b $(whoami)-dev
git push -u origin $(whoami)-dev 

You can now start working on your branch. Don't forget to check Delete branch when merged.

Release

Merge dev into master will release a new version and prepare a new version in dev.

To release a new version, prepare the Changelog and set the version in package.json then merge your change into master.

If you want to use Git as a npm repository, you will need to push dist and lib:

$ sed -i "/lib\|dist/d" .gitignore

If you want to use npm repository :

$ grep -q -F 'lib' .gitignore || echo 'lib' >> .gitignore
$ grep -q -F 'dist' .gitignore || echo 'dist' >> .gitignore

⚠️ if you are releasing on a git repository instead of a npm repository, DO NOT forget to add build, and dist to the .gitignore ⚠️, those are removed when you initialize the module with npm run create.

License

Copyright (c) $YEAR Yeutech Company Limited. For more information [email protected]. Made with rollup-umd 0.3.9