贡献指南

注意：此文档不是最新，请参考：https://vue-devui.github.io/contributing/

Fork仓库

1. Fork仓库到个人空间
2. Clone个人空间项目到本地：git clone [email protected]:username/vue-devui.git
3. 设置upstream：git remote add upstream [email protected]: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

提交之前需要给Commit添加GPG签名，参考：https://insights.thoughtworks.cn/how-to-sign-git-commit/

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. 组件功能自检：组件自检清单

目前 PR 添加了以下门禁，必须满足以下所有条件才可以合入：

1. 至少一位检视者同意(At least 1 approving review is required by reviewers)
2. 所有检视意见是已解决状态(No unresolved conversations)
3. yarn build网站构建成功(Build sucessfully)
4. 提交信息语义化规范检测(Semantic Pull Request ready to be squashed)
5. 所有提交均已签名(Verified)

PR 合入之后自动触发Sync to Gitee任务，将最新代码同步到Gitee仓库

代码检视

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

贡献者名单

任何对DevUI开源项目有贡献的社区成员都可以通过在任意issue/pr中评论：

@all-contributors please add @<username> for <contributions>

自动加入README的贡献者列表。

具体的<contributions>的可选列表可以参考以下链接：

https://allcontributors.org/docs/en/emoji-key