bkui-vue 0.0.1-beta.3 → 0.0.1-beta.32

package/README.md

@@ -1,51 +1,63 @@
-# bkui-vue
+![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) <!--[![month dowloads](http://img.shields.io/npm/dm/bkui-vue.svg)](https://npmcharts.com/compare/bkui-vue?minimal=true)--> [![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
 
-#### 如何新增使用一个icon
-
-* 将你的svg保存到 packages/icon/src/svg目录下
-* 重命名为你的icon使用的具有识别的英文名称
-* 执行命令 yarn generate:icon 
-* 在组件中使用类似语法`import { HelpFill } from '@bkui-vue/icon/';`引用即可
-
+* 将你的 svg 保存到 `packages/icon/src/svg` 目录下
+* 重命名为你的 icon 使用的具有识别的英文名称
+* 执行命令 `yarn generate:icon`
+* 在组件中使用类似语法 `import { HelpFill } from '@bkui-vue/icon/';` 引用即可
 
 ## 如何开始
 
-想要贡献代码，建议请先参照已有的特性文档和开发环境构建文档。可以运行`npm run plop` 输入组件名生成新组件模板
+想要贡献代码，建议请先参照已有的特性文档和开发环境构建文档。可以运行 `yarn cc` 输入组件名生成新组件模板
 
-## GIT提交规范
+## GIT 提交规范
 
-为了规范commit-msg格式，建议使用yarn cz自动生成commit-msg, 不同的提交标记以规范化区分提交内容：
-```
+为了规范 commit-msg 格式，建议使用 `yarn cz` 自动生成 commit-msg, 不同的提交标记以规范化区分提交内容：
 
+```
 <标记>(<组件名称>): [提交的概要注释] issue #[123]
 // 空一行
-<本次变更详细说明> 
+<本次变更详细说明>
 // 空一行
 <footer>
 ```
@@ -57,19 +69,19 @@ chore(common): 梳理组件库开发流程
 
 affects: bkui-vue, @bkui-vue/button, @bkui-vue/checkbox, @bkui-vue/input, @bkui-vue/radio
 
-允许单个组件执行jest任务
-添加Husky提交流程较验
-添加chanelog自动生成机制
+允许单个组件执行 jest 任务
+添加 husky 提交流程较验
+添加 chanelog 自动生成机制
 
 ISSUES CLOSED: #1
 ```
 
-### 标记说明:
+### 标记说明
 
 | 标记           | 说明                                        |
 | -------------- | ------------------------------------------- |
 | feature/feat   | 新功能开发                                  |
-| bug/fix/bugfix | bug修复                                     |
+| bug/fix/bugfix | bug 修复                                     |
 | refactor/perf  | 重构代码/优化配置&参数/优化逻辑及功能       |
 | test           | 添加单元测试用例相关                        |
 | docs           | 添加文档                                    |
@@ -78,4 +90,4 @@ ISSUES CLOSED: #1
 | merge          | 仅做分支合并同步                            |
 | depend         | 对工程的依赖进行增删改                      |
 | chore          | 构建脚本、任务等相关代码                    |
-| del            | 删除可能仍然有人用到的功能、API等破坏性动作 |
+| del            | 删除可能仍然有人用到的功能、API 等破坏性动作 |

package/README_EN.md

@@ -0,0 +1,93 @@
+![bkui-vue3](docs/logo-en.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) <!--[![month dowloads](http://img.shields.io/npm/dm/bkui-vue.svg)](https://npmcharts.com/compare/bkui-vue?minimal=true)--> [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentBlueKing/bkui-vue3/pulls)
+
+English | [简体中文](README.md)
+
+# bkui-vue3
+
+A UI library base on BlueKing Magicbox and 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
+```
+
+#### How to add an icon
+
+* Save your svg to the `packages/icon/src/svg` directory
+* Rename to a recognizable English name used by your icon
+* Execute the command `yarn generate:icon`
+* Use similar syntax `import { HelpFill } from '@bkui-vue/icon/';` in the component to reference
+
+## How to get started
+
+If you want to contribute code, it is recommended to refer to the existing feature documentation and development environment build documentation first. You can run `yarn cc` and enter the component name to generate a new component template
+
+## GIT commit specification
+
+In order to standardize the commit-msg format, it is recommended to use `yarn cz` to automatically generate commit-msg, with different commit markers to standardize and differentiate the commit content:
+
+```
+<tag>(<component name>): [submitted summary notes] issue #[123]
+// Skip a line
+<details of this change>
+// Skip a line
+<footer>
+```
+
+example:
+
+```shell
+chore(common): Standard component library development process
+
+affects: bkui-vue, @bkui-vue/button, @bkui-vue/checkbox, @bkui-vue/input, @bkui-vue/radio
+
+Allow a single component to execute jest tasks
+Add husky submission process verification
+Add chanelog automatic generation mechanism
+
+ISSUES CLOSED: #1
+```
+
+### tag description
+
+| tag           | description                                        |
+| -------------- | ------------------------------------------- |
+| feature/feat   | new feature development                                  |
+| bug/fix/bugfix | bug fix                                     |
+| refactor/perf  | refactor code/optimize configuration & parameters/optimize logic and functions       |
+| test           | add unit test case related                        |
+| docs           | add document                              |
+| info           | add comment information              |
+| format         | Without modifying the business logic, only format the code specification      |
+| merge          | only do branch merge sync                            |
+| depend         | add, delete and modify the dependencies of the project                      |
+| chore          | build scripts, tasks and other related code                    |
+| del            | remove disruptive actions such as features, APIs, etc. that may still be used |