Contributing

Setup

git clone git@github.com:owowagency/bootstrap-vue.git
cd bootstrap-vue
yarn

This package utilizes Storybook to easily develop components in isolation. It also serves as the demo page of all the components.

yarn storybook

Follow the code styling defined in .eslintrc.js.

yarn lint

Follow the commit message structure of semantic-release.

All code of this package is tested using Vitest.

yarn test

Each component is stored in its own folder in the src/components folder.

In this folder the following files are required to be present:

Vue component file named after the component itself, example: Alert.vue. This file contains the code of the component itself.
A storybook file to preview the component, Alert.stories.ts.
A test file in which the component is tested, Alert.test.ts.
A README.md file that at least contains an example, and definitions for props, events, and slots.

Furthermore this component needs to be exported and made available to consumers in the final build.