贡献指南

Fork仓库

1. Fork仓库到个人空间
2. Clone个人空间项目到本地：git clone git@github.com:username/vue-devui.git
3. 设置upstream：git remote add upstream git@github.com:DevCloudFE/vue-devui.git
4. 加入Vue DevUI技术交流群，添加小助手微信devui-official

本地启动

1. 安装依赖：yarn
2. 本地启动：yarn dev
3. 浏览器访问：http://localhost:3000/
4. 构建网站：yarn build
5. 构建组件库：yarn build:lib
6. 执行单元测试：yarn test

认领任务

1. 在issue列表中选择自己感兴趣的任务，评论下认领该任务

提交PR

1. 拉取特性分支：git checkout -b username/feature1
2. 本地编码
3. 添加修改到暂存区：git add .
4. 提交到本地仓库：git commit -m "feat(scope): commit message"
5. push到远程仓库：git push origin username/feature1
6. 在上游仓库提交PR：https://github.com/DevCloudFE/vue-devui/pulls

如果需要同步上游仓库dev分支最新代码，可以执行以下命令：

git pull upstream dev

如果涉及新组件或组件的新特性，则需要：

1. 完善组件的中英文文档
2. 完善组件的单元测试
3. 组件功能自检：组件自检清单

代码检视

1. 仓库管理员检视PR，并提出检视意见
2. PR作者修复问题并将检视意见设置成已完成
3. 仓库管理员合入PR