如何成为开源项目的贡献者(提交PR)
# Pull Request 规范
- 如果遇到问题,建议保持你的 PR 足够小。保证一个 PR 只解决一个问题或只添加一个功能
- 当新增组件或者修改原有组件时,记得增加或者修改测试代码,保证代码的稳定
- 在 PR 中请添加合适的描述,并关联相关的 Issue
# 简约版
# Pull Request 流程
- fork 主仓库,如果已经 fork 过,请同步主仓库的最新代码
- 基于 fork 后仓库的 dev 分支新建一个分支,比如
feature/button_color
- 在新分支上进行开发,开发完成后,提 Pull Request 到主仓库的 dev 分支
- Pull Request 会在 Review 通过后被合并到主仓库
- 等待 Vant 发布版本,一般是每周一次
# 同步最新代码
提 Pull Request 前,请依照下面的流程同步主仓库的最新代码:
# 添加主仓库到 remote,作为 fork 后仓库的上游仓库
git remote add upstream https://github.com/youzan/vant.git
# 拉取主仓库最新代码
git fetch upstream
# 切换至 dev 分支
git checkout dev
# 合并主仓库代码
git merge upstream/dev
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 详尽版
# 1. fork开源项目
- 打开Github,找到开源项目主页,点击右上角“Fork”
- 经过数秒的loading后即可完成,页面跳转到forked 之后自己的仓库里
# 2. clone fork 到自己仓库的代码
git clone git@github.com:izhaong/***.git
1
- 对第二次提交来讲,上面的操作已经做过一遍了。需要对自己fork的仓库代码与原仓库代码进行同步
- 然后在本地拉取最新的代码
# 3. 在专有的开发分支上完成代码提交
基本上仓库主分支只是最新稳定版本的快照。所有开发都应在专用分支中完成。不要针对主分支提交 PR。
# 4. 创建pull request
- 打开Github 个人仓库页面,会有工作分支push记录,以及“ Compare & pull request ”的提醒
- 点击“ Compare & pull request ”进入“Open a pull request”,填写PR描述后点击“Create pull request”完成创建。
pr被接受后,自己远程仓库的工作分支可删除,本地工作分支也可删除,同时你也是一名光荣的贡献者
# 疑问
如果您没有在仓库的贡献者图中显示,可能是因为:
- 您并非前 100 名贡献者之一。
- 您的提交尚未合并到默认分支。
- 您用于创作提交的电子邮件地址未连接到到您的 GitHub 帐户。
上次更新: 2022/05/02, 01:28:34