FORMA-COMMON PACKAGE DOCUMENTATION

• Introduction
• Update this package
• Installation
• Use

Introduction

This package is npm package in TypeScript for FormaDash project (BrutDeCom project).

Update this package

1. Run git clone https://github.com/BrutdeCom/forma-common.git
2. Create branch for your additions, and go to your local branch
3. Run npm i
4. Make your code with love. Tested code is better.
5. Code is finished ? Run git add ., then git commit -m '[your atomic commit]'
6. Run npm run release. Launch tests, and update package version. Is obligatory for the rest.
7. Run git push origin [your branch]
8. Create your pull request to production branch. If actions passed, validate your PR.
9. It's good, package is automatically published.
10. In your project, update forma-common to use your new features.

Installation

For install this package, run npm i forma-common

Use

Example for require one part of this package :

import { IMyInterface } from forma-common