# bkui-vue3 **Repository Path**: Samisland/bkui-vue3 ## Basic Information - **Project Name**: bkui-vue3 - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: staging - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-03-16 - **Last Updated**: 2024-03-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ![bkui-vue3](docs/logo.png) --- [![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/TencentBlueKing/bkui-vue3/blob/master/LICENSE.txt) [![Release Version](https://img.shields.io/npm/v/bkui-vue.svg)](https://www.npmjs.com/package/bkui-vue) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentBlueKing/bkui-vue3/pulls) [English](README_EN.md) | 简体中文 # bkui-vue3 基于蓝鲸 Magicbox 和 Vue3 的前端组件库 ## Project setup ``` yarn install ``` ### Compiles and hot-reloads for development ``` yarn dev ``` ### Compiles and minifies for production ``` yarn build ``` ### Run your unit tests ``` yarn test ``` ### Lints and fixes files ``` yarn lint ``` #### 如何新增使用一个 icon * 将你的 svg 保存到 `packages/icon/src/svg` 目录下 * 重命名为你的 icon 使用的具有识别的英文名称 * 执行命令 `yarn generate:icon` * 在组件中使用类似语法 `import { HelpFill } from '@bkui-vue/icon/';` 引用即可 ## 如何开始想要贡献代码，建议请先参照已有的特性文档和开发环境构建文档。可以运行 `yarn cc` 输入组件名生成新组件模板 ## GIT 提交规范为了规范 commit-msg 格式，建议使用 `yarn cz` 自动生成 commit-msg, 不同的提交标记以规范化区分提交内容： ``` <标记>(<组件名称>): [提交的概要注释] issue #[123] // 空一行 <本次变更详细说明> // 空一行