product-ui v4.0.0-beta.1

product-ui

Shared product related components for vend

Table of Contents

1. Integrating
   1. JavaScript
2. Contributing
3. Publishing

Integrating

To use product-ui in your application depend on it in your bower.json file (where X.Y.Z is the version of product-ui to depend on):

{
  "dependencies": {
    "product-ui": "git@github.com:vend/product-ui.git#vX.Y.Z"
  }
}

JavaScript

To depend on and use the various angular components provided by product-ui:

1. Depend on the product-ui module in your application's top level module declaration:

angular.module('my-application', ['product-ui'])

Contributing

To contribute:

1. make your changes in a separate branch
2. create a pull request and get it code reviewed
3. once past code review, merge to master
4. publish a new version on master (see below)

Publishing

This module is published via np. To version and publish, run the following on a clean, up to date master branch:

np <patch/major/minor>

Use the appropriate release type:

• patch - release contains bug fixes only
• minor - release contains new features but no breaking changes
• major - release contains breaking changes

Voila!

Must use np version 2.12.X until https://trello.com/c/ittOQixG is fixed.