参与开源项目:提交PR

这篇文章描述笔者发现sharding-sphere的一个BUG,然后如何规范的提交PR的整个过程。

issue

PR的第一步就是提交issue,即提交你发现的BUG:


Bug Report

说明,如果不是BUG,而是一些优化建议,那么选择"Feature Request"。


接下来填入BUG的标题和描述,如下所示:

BUG的标题:
RoundRobinMasterSlaveLoadBalanceAlgorithm throw an ArrayIndexOutOfBoundsException,

BUG的描述(注意说明,只接受英文描述,直接会被拒绝。如果英文不够6,建议借助:translate.google.cn):


image.png

提交Issue后,静静的等待官方确认。

下载代码

得到官方确认后,Fork分支:

fork

接下来下载你刚才fork分支的代码(我比较喜欢SSH方式,即Clone with SSH):


clone or download

得到地址后,在PC上执行如下命令即可:

git clone git@github.com:feelwing1314/sharding-sphere.git

配置SSH KEYS

需要注意的是,如果是第一次下载源码,需要配置SSH KEYS,只需要简单几步即可:

cd ~/.ssh
ssh-keygen -t rsa

执行ssh-keygen这个命令的交互过程中,下面的3个地方都需要你的输入确认,全部按回车即可,
第一个回车表示生成的key保存在/c/Users/afei/.ssh/id_rsa文件中,
第2,3个回车表示以后本机的git操作都不需要密码;
Generating public/private rsa key pair.
Enter file in which to save the key (/c/Users/afei/.ssh/id_rsa):
Enter passphrase (empty for no passphrase):
Enter same passphrase again:

最后将生成的key,即C:\Users${username}.ssh目录下id_rsa.pub文件中的内容拷贝到Github的Settings->SSH and GPG keys->New SSH key中即可,接下来就可以在你的PC上git clone了:

New SSH key

Fix Bug

下载代码后,建议创建一个分支再修改BUG,并且最好基于当前的开发分支,以sharding-jdbc为例,当前的开发分支是dev,创建一个fix-1265分支:

基于当前(dev)分支创建一个分支并切换到创建的分支:
git checkout -b fix-1265

接下在就是在本地修复BUG,然后commit&push。

更新fork分支

这里还有一种情况,就是之前已经fork过,这次要更新fork分支的代码为最新代码,需要如何几个步骤:

git remote add upstream git@github.com:sharding-sphere/sharding-sphere.git

查看远程分支:
git remote -v
如果现实有4条记录表示远程分支创建OK:
origin  git@github.com:feelwing1314/sharding-sphere.git (fetch)
origin  git@github.com:feelwing1314/sharding-sphere.git (push)
upstream        git@github.com:sharding-sphere/sharding-sphere.git (fetch)
upstream        git@github.com:sharding-sphere/sharding-sphere.git (push)

fetch源分支的新版本到本地:git fetch --all
合并两个版本的dev分支代码:git rebase upstream/dev
将合并后的代码push到github上去:git push origin dev

Pull Request

接下来就是最后一步Pull Request,即PR。

当你在上一步push代码后,再访问你自己的github主页时,会有pull request提示:


pull request notice

点击"Compare & pull request"后,就会到下面这个页面,文本框中Fixes后的issue编号就是当初提交issue的编号,最后点击Create pull request即可:

open a pull request

在这一页还有commit change信息,展示你此次提交的变更信息:


commit change

创建PR后,可以看到你的PR进度,接下来就耐心的等待官方接受你的PR吧:


pr process

笔者此次Pull Request参考:https://github.com/sharding-sphere/sharding-sphere/pull/1279

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,133评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,682评论 3 390
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,784评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,508评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,603评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,607评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,604评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,359评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,805评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,121评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,280评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,959评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,588评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,206评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,193评论 2 367
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,144评论 2 352

推荐阅读更多精彩内容

  • 多种多样的工作流使得在项目中实施Git时变得难以选择。这份教程提供了一个出发点,调查企业团队最常见的Git工作流。...
    JSErik阅读 4,397评论 2 8
  • 1.GitHub 有什么用 学习优秀的开源项目开源社区一直有一句流行的话叫「不要重复发明轮子」,某种意义上正是因为...
    Clemente阅读 1,428评论 1 14
  • 刚才发了在简书的第一篇“文章”。 我已经很久没有发微博了,其中一个重要的原因是140字的限制。今天心血来潮,又想发...
    柚子皮870阅读 129评论 0 0
  • 一、求学 在战国时期,有个燕国人家住在寿陵的少年想要闯荡出一番作为,他听说赵国邯郸人有一种舞步叫做“踮屣”,如同跳...
    愚者愚心阅读 5,003评论 0 0
  • 这两块冰种飘花带黄翡的片料,出自同一块料子,这块料子就是来自于大家熟悉的场口——后江场口。后江翡翠原石,大家已在阿...
    a446f3af2168阅读 776评论 0 0