同步操作将从 DevUI/vue-devui 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
你好!我们很高兴你有兴趣为 Vue DevUI 做出贡献。在提交你的贡献之前,请花点时间阅读以下指南:
Vue DevUI 使用 pnpm
构建 monorepo
仓库,你应该使用 pnpm 6.x 包管理器,以确保不会因为包管理器的不同而引发异常。
pnpm 7.x 发生了break change,如要使用pnpm 7.x 请自行更新
package.json
的script,例如本地启动:pnpm --filter vue-devui dev
,其他修改可以查阅上述链接。
如果你想参与 devui-vue
的开发或者测试:
git clone git@github.com:username/vue-devui.git
pnpm i
, 安装 node 依赖pnpm dev
,启动组件库网站# 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 列表 中选择自己感兴趣的任务,在评论区认领。
提交之前需要给Commit添加GPG签名,参考:https://insights.thoughtworks.cn/how-to-sign-git-commit/
git checkout -b username/feature1
,分支名字建议为username/feat-xxx
/username/fix-xxx
git push origin branchName
git pull upstream dev
如果涉及新组件或组件的新特性,则需要:
代码在提交之前会自动执行 ESLint 检查,并且在 GitHub PR 提交门禁中也加上了 ESLint 检查任务,所以在提交之前请确保你的代码符合 ESLint 规范,ESLint 检查不通过,PR 将无法合入哦。
你可通过执行以下命令来手动执行代码检查:
# 执行 ESLint 检查
pnpm cli --filter vue-devui -- code-check -t eslint
pnpm cli --filter vue-devui -- code-check -t eslint -c alert,button
# 执行单元测试
pnpm cli --filter vue-devui -- code-check -t unit-test
pnpm cli --filter vue-devui -- code-check -t unit-test -c alert,button
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。