-
Notifications
You must be signed in to change notification settings - Fork 290
贡献指南
Kagol edited this page Apr 13, 2022
·
6 revisions
注意：此文档不是最新，请参考：https://vue-devui.github.io/contributing/
- Fork仓库到个人空间
- Clone个人空间项目到本地：
git clone [email protected]:username/vue-devui.git - 设置upstream：
git remote add upstream [email protected]:DevCloudFE/vue-devui.git - 加入
Vue DevUI技术交流群，添加小助手微信devui-official
- 安装依赖：
yarn - 本地启动：
yarn dev - 浏览器访问：http://localhost:3000/
- 构建网站：
yarn build - 构建组件库：
yarn build:lib - 执行单元测试：
yarn test
- 在issue列表中选择自己感兴趣的任务，评论下认领该任务
提交之前需要给Commit添加GPG签名，参考：https://insights.thoughtworks.cn/how-to-sign-git-commit/
- 拉取特性分支：
git checkout -b username/feature1 - 本地编码
- 添加修改到暂存区：
git add . - 提交到本地仓库：
git commit -m "feat(scope): commit message" - push到远程仓库：
git push origin username/feature1 - 在上游仓库提交PR：https://github.com/DevCloudFE/vue-devui/pulls
如果需要同步上游仓库dev分支最新代码，可以执行以下命令：
git pull upstream dev
如果涉及新组件或组件的新特性，则需要：
- 完善组件的中英文文档
- 完善组件的单元测试
- 组件功能自检：组件自检清单
目前 PR 添加了以下门禁，必须满足以下所有条件才可以合入：
- 至少一位检视者同意(
At least 1 approving review is required by reviewers) - 所有检视意见是已解决状态(
No unresolved conversations) -
yarn build网站构建成功(Build sucessfully) - 提交信息语义化规范检测(
Semantic Pull Request ready to be squashed) - 所有提交均已签名(
Verified)
PR 合入之后自动触发Sync to Gitee任务，将最新代码同步到Gitee仓库
- 仓库管理员检视PR，并提出检视意见
- PR作者修复问题并将检视意见设置成已完成
- 仓库管理员合入PR
任何对DevUI开源项目有贡献的社区成员都可以通过在任意issue/pr中评论：
@all-contributors please add @<username> for <contributions>
自动加入README的贡献者列表。
具体的<contributions>的可选列表可以参考以下链接：