Install package

• yarn add menadx-ui

Updgrade package

• yarn upgrade menadx-ui

Git Guidelines

• Follow gitflow workflow model, as discussed in the link.
  • A develop branch is created from master
  • A release branch is created from develop
  • Feature branches are created from develop
  • When a feature is complete it is merged into the develop branch
  • When the release branch is done it is merged into develop and master
  • If an issue in master is detected a hotfix branch is created from master
  • Once the hotfix is complete it is merged to both develop and master

Publishing to npm

• Run yarn run release
• From the choices, select version type(link)
  • MAJOR version when you make incompatible API changes.
  • MINOR version when you add functionality in a backwards compatible manner.
  • PATCH version when you make backwards compatible bug fixes.
• The above script will create a version tag and push the tags to git
• After this step, create a PR in release branch.

Publish to heroku

• The storybook for this project can be accessed here.

Run Project Locally

• Clone the repo using git clone
• Install dependencies using yarn
• Run storybook using npm start
• Load storybook on http://localhost:8080 in browser

Available Scripts

• For linting the project using tslint use yarn lint

• For automatic lint fixes use yarn run lint:fix

• For conflicting lint rules in base and prettier use yarn run lint:check

Git hooks

This repo has git hooks for commit and push, if any of the command throws error it will fail the commit or push (This can be bypassed using git commit --no-verify).

• Before commit: Automatic prettier and yarn lint:fix are run.

• Before push: the command yarn lint is run.

Coding guidelines

• Use proptypes check for runtime prop validation check(as this repo can be used with project which does not use typescript).

TODOS

| Task | Status | Comments | | ------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------: | -------: | | compare destructuring versus the .defaultProps as it declare Partial and when we call from story, it assumes this is mandatory keys. | | | | Unit Tests for designs | | | | Unit Tests for functionality | | | | Map types and interfaces to prop types for single source of type checks and make all types in sync | | | | Add coding guidelines for extending components | | |