0.1.7 • Published 4 years ago

@internethic/oparedo-ui v0.1.7

Weekly downloads
-
License
-
Repository
-
Last release
4 years ago

OPAREDO VUEJS UI (@internethic/oparedo-ui)

Netlify Status

Storybook available here : https://oparedo-ui.netlify.com/

Build is automatically triggered by netlify everytime a changed is pushed to the master branch.

Install

npm install @internethic/oparedo-ui

Usage

import Vue from 'vue'
import OparedoUI from '@internethic/oparedo-ui'
import '@internethic/oparedo-ui/dist/oparedo-ui.css'

Vue.use(OparedoUI)

How to add your component

  1. Create a git branch for your component
  2. Create a folder named with your component name in CamelCase
  3. Add your vue component file in CamelCase
  4. Create a story for your component
  5. Register your component in rollup listing src/index.js file
  6. Build the components index file with rollup npm run build
  7. Commit your component branch
  8. Ask for a merge request on master assigned to a frontend dev

How to publish a new version of the package

  1. Update package version in package.json
  2. run "npm publish" (@TODO prepublish linting & testing)

Commit types

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

TODO

  • Add Storybook Snapshots
  • CI for rollup build