本文带大家给element-plus提交第一个开源贡献
我们先从最简单的文档开始, 因为文档的PR最快, 也最简单
- 将element-plus项目fork到自己的github账号
fork后你的仓库里面就会多出一个element-plus
2. 将你账号下的elemnt-plus项目拉下来
git clone https://github.com/你的账号/element-plus.git
- 安装依赖, 启动文档项目
// element-plus要求开发环境:
// NodeJS >= 18
// Pnpm >= 9.5
// Git > v2.20
// 注意: 由于网络环境/系统等因素, 此步骤可能会出现错误, 失败的话可以多试几遍
pnpm i
// 文档的调试命令, 启动后可访问http://localhost:5173/预览
pnpm docs:dev
-
修改源码
md文档放在
docs/en-US/component/***.md, 默认分支是dev, 你可以直接修改dev分支的代码, 也可以基于dev签出分支来修改element-plus只有英文文档需要维护, 具体修改什么你可以看看官网缺少什么, 可以是使用示例, 组件说明(props, events, methods, slot), 甚至是标注属性生效的最低版本
我本次修改的是calendar, 这个组件的
组件方法还没有人完善, 写完之后调试预览一下有没有问题 (如果是修改js源码这些需要pnpm test单元测试一下, 我修改的是md文档就不做这些测试了)
-
提交commit
文档的commit message格式是
docs: [组件名] 修改内容(注意这里不需要加编号, 编号是后面自动生成的!)本地提交完之后, 将改动push到你的github仓库
-
提交PR
打开element-plus官方的仓库, 点击Pull requests, 点击New pull request
-
查看进度
成功提交后, 会生成一个PR记录
滚动到底部查看流程进度
element-plus管理员还是比较活跃的, 文档相关的PR一般几个小时就会给你消息
如果你的提交有问题, 管理员会给你`留言`或者直接帮你修改源码
如果是留言的话, 你需要在本地重新修改错误的地方, commit / push, push后代码会自动同步到PR记录!, 接下来就等管理员再次审批
如果他在PR直接给你修改源码, 你需要点击File changed, 处理一下是否接受他的修改, 同意之后就可以等着了
昨天提的, 今天就合并了, 嘻嘻
