patd-vue

v3.0.2

Published

a year ago

Vue component library based on Pay.css

Downloads

0High
0Medium
0Low

neverming

gmq793

PATD-VUE 开发上手指南

React UI library based on Pay.css

结构介绍

  - pay-css：这是一个submodule独立的代码库,也是一个独立的项目，用来编写和生成CSS样式的代码库。
  - example：这是一个可以运行的项目，用来展示编写的组件样式和测试功能。
  - src: 组件在这个目录下编写。
  - docs: 这个是PATD官网组件文档引用的md,在这里编写官方文档.

安装

要开始Patd-vue的开发，需要同安装好pay-css,patd-vue,example 三个项目。

请注意你的Node JS 版本：

Node 版本：16.14.0 (软件超市可以安装)
npm 版本： 8.5.5

初始化 submodul Pay-css

git submodule init
git submodule update

安装 Pay-css

patd-vue: cd pay-css
pay-css: npm install

安装 Patd-vue

patd-vue: npm install

安装 Example

由于Cypress依赖需要外网环境安装，所以安装依赖Cypress时可能会报错。Cypress的报错并不影响项目启动，可以跳过。
更好的办法是在package.json当中去掉 Cypress, 这是个用来测试的依赖，开发不会用到。

patd-vue: cd example
example: npm install

启动项目 start

首先启动pay-css，让他生成css文件，patd-vue的大部份样式都依赖于此，编写样式也在这里完成。

patd-vue: cd pay-css
pay-css: npm run start

然后我们就可以开始开发了，启动我们的patd-vue

patd-vue: npm run start

最后我们想要查看我们的组件效果，所以也要启动example项目，实时查看最终的效果。

patd-vue: cd example
example: npm run start

同时启动以上三个项目，最后打开http://localhost:8080/#/ 就可以开始开发了

代码提交规范

项目已开启神兵钩子检测，提交需要按照规范格式

<空间简称#卡片ID> <type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

header

空间简称#卡片ID

必填。故事卡片、任务卡片、缺陷卡片三类卡片可提交代码，该信息可以直接通过卡片标题前的复制按钮获取

type

必填。

feat：新功能,新特性（feature）
fix：修复bug
docs：文档（documentation）
style：代码格式修改，功能保持不变
test：测试用例修改,
chore：构建过程或辅助工具的变动, 比如构建流程, 依赖管理等.(无法判断的提交推荐用这个)

scope

可选。 scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。也可以是route, component, utils, build...

subject

必填。 subject是 commit 目的的简短描述，不超过50个字符

body

Body 部分是对本次 commit 的详细描述，可以分成多行。提交的时候应该说明代码变动的动机，以及与以前行为的对比。

footer

footer 部分只用于两种情况。

不兼容变动如果当前代码与上一个版本不兼容，则 footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。
关闭 Issue 如果当前 commit 针对某个issue，那么可以在 footer 部分关闭这个 issue 。

Closes #123, #234, #345