@internethic/oparedo-ui
v0.1.7
Published
VueJS Components
Downloads
28
Readme
OPAREDO VUEJS UI (@internethic/oparedo-ui)
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
- Create a git branch for your component
- Create a folder named with your component name in CamelCase
- Add your vue component file in CamelCase
- Create a story for your component
- Register your component in rollup listing
src/index.js
file - Build the components index file with rollup
npm run build
- Commit your component branch
- Ask for a merge request on master assigned to a frontend dev
How to publish a new version of the package
- Update package version in package.json
- 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