美文网首页vue
Vue DevUI 贡献指南

Vue DevUI 贡献指南

作者: 深度剖析JavaScript | 来源:发表于2022-03-25 11:41 被阅读0次

你好!我们很高兴你有兴趣为 Vue DevUI 做出贡献。在提交你的贡献之前,请花点时间阅读以下指南:

快速上手

Vue DevUI 使用 pnpm 构建 monorepo 仓库,你应该使用 pnpm 包管理器,以确保不会因为包管理器的不同而引发异常。

如果你想参与 devui-vue 的开发或者测试:

  1. 点击 Github 右上角的 Fork 按钮,将仓库 Fork 仓库到个人空间
  2. Clone 个人空间项目到本地:git clone git@github.com:username/vue-devui.git
  3. 在 Vue DevUI 的根目录下运行pnpm i, 安装 node 依赖
  4. 运行 pnpm dev,启动组件库网站
  5. 使用浏览器访问:http://localhost:3000/
# username 为用户名,执行前请替换
git clone git@github.com:username/vue-devui.git
cd vue-devui
git remote add upstream git@github.com:DevCloudFE/vue-devui.git
pnpm i
pnpm dev

参与贡献

Vue DevUI 是一个多人合作的开源项目,为了避免多人同时开发同一个组件/功能,请先在 issues 列表 中选择自己感兴趣的任务,在评论区认领

  1. 请确保你已经完成快速上手中的步骤,并且正常访问http://localhost:3000/
  2. 创建新分支 git checkout -b username/feature1,分支名字建议为username/feat-xxx/username/fix-xxx
  3. 本地编码,需遵循开发规范
  4. 遵循 Angular Commit Message Format 进行提交(不符合规范的提交将不会被合并
  5. 提交到远程仓库,也就是 Fork 后的仓库,git push origin branchName
  6. (可选) 同步上游仓库dev分支最新代码,git pull upstream dev
  7. 打开上游仓库提交 PR
  8. 仓库 Committer 进行 Code Review,并提出意见
  9. PR 发起人根据意见调整代码(一个分支发起了 PR 后,后续的 commit 会自动同步,不需要重新 PR)
  10. 仓库管理员合并PR
  11. 贡献流程结束,感谢你的贡献

如果涉及新组件或组件的新特性,则需要:

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

相关文章

  • Vue DevUI 贡献指南

    你好!我们很高兴你有兴趣为 Vue DevUI 做出贡献。在提交你的贡献之前,请花点时间阅读以下指南: 快速上手 ...

  • Vue DevUI 开发规范

    Vue DevUI 是一个社区共建的开源组件库,为了确保一致性和质量,需要所有参与 Vue DevUI 建设的贡献...

  • 自动生成左侧导航及入口文件

    pnpm cli --filter vue-devui -- create

  • 如何给Vue3组件库加单元测试

    Vue DevUI的单元测试环境是基于Jest和Vue Test Utils的,所以它的步骤如下: 首先,安装je...

  • vue3源码解析

    Vue3源码解析 准备工作至项目结构为翻译官方贡献者指南[https://github.com/vuejs/cor...

  • Vue文档学习(第1遍)

    Vue教程: Vue API: Vue风格指南: Cookbook

  • 如何参与一个开源项目

    如何参与一个开源项目,提交我的第一次PR? 以vue-devui为例,步骤如下 fork仓库 生成和配置SSH公钥...

  • vue.js v1 懒加载实践

    vue指南说,可以异步加载component vue指南 => 异步加载组件 注意 下面的内容假设你已经学会: w...

  • 代码贡献指南

    很高兴你对Matermost open source project感兴趣。为了帮助翻译,请参阅本地化过程。 对于...

  • Bioconda贡献指南

    注:本文适用于非 Bioconda 成员 Step0:软件开发与GitHub操作 (1) 将开发完成的软件上传到G...

网友评论

    本文标题:Vue DevUI 贡献指南

    本文链接:https://www.haomeiwen.com/subject/wonrjrtx.html