@pitcher/vue-sdk

Pitcher VUE.JS SDK

This package is not being developed for new features, maintenance only.

Please open pull request if you want to change something and please include docs and unit tests. If you have a bug fix or feature request feel free to open a new issue.

Documentation

https://pitcherag.github.io/pitcher-vue-sdk/

Changelog

Project setup

To start development you need Node.js and NPM installed on your machine.

1. npm install if you are on npm version < 7 or
   npm install --legacy-peer-deps if you are on npm >= 7
2. npm run demo
3. Profit! You can start making changes and they will be hot reloaded

How to contribute

Step by step contribution guide

Steps

1. Create your own branch and work on it
2. Write tests, especially if you are creating a new component
3. Tests
4. Go back to step 2
5. execute npm run lint to lint the files
6. Update changelog, write what you have changed/fixed/added. If there is not a heading for the next version, add it.
7. Create a pull request
8. If you are unsure about something, ask in pitcher-vue-sdk channel