纪念下我对开源社区的首个贡献一个flink中文文档翻译相关的commit

前言

作为一名十四年整体IT经验&＃xff0c;且包含六年大数据开发/运维/架构设计/方案咨询经验的IT老兵&＃xff0c;明哥有些惭愧&＃xff0c;这些年来对于开源社区&＃xff0c;一直都是拿来主义&＃xff0c;虽然为了适应业务需求有时会基于开源版本进行二次定制开发&＃xff0c;但从来没有回馈过社区。

近两三年来&＃xff0c;尤其是从2019年初阿里收购了flink背后的商业公司Data Artisan后且成立了商业公司Ververica后&＃xff0c;flink在国内发展的如火如荼&＃xff0c;已经成为国内流处理领域事实上的首选框架&＃xff0c;使用该技术的公司也逐渐从互联网行业渗透到其它传统行业。同时 Apache Flink 中文社区通过各种 summit 和 meetup&＃xff0c;以行业实践案例&＃xff0c;博客分享&＃xff0c;专业教程等不同形式&＃xff0c;也在不断布道推动flink的发展和应用&＃xff0c;在flink官网上更是专门推出了中文版&＃xff0c;来适应英文不太好的小伙伴。

在这样的大背景下&＃xff0c;明哥公司的流处理框架选型默认也切换为了flink。同时&＃xff0c;本着拥抱开源回馈开源的精神&＃xff0c;明哥觉得有必要回馈开源社区做出自己的一份贡献了。对明哥来说&＃xff0c;一个很好的切入点&＃xff0c;就是给flink社区贡献文档和中文翻译&＃xff0c;因为这刚好可以用上明哥良好的英文功底&＃xff08;明哥毕竟是当年高考英语成绩131.5&＃xff0c;工作后在外企HP/IBM工作了十年&＃xff0c;与美国人加拿大人巴西人新加坡人甚至印度人各种会议历练过来的。哈哈&＃xff0c;扯远了。&＃xff09;

如何开始准备工作

其实为方便对社区不熟悉的贡献者快速上手&＃xff0c;flink中文社区做了很多工作&＃xff0c;比如在官网首页特地详细讲述了如何贡献&＃xff0c;也特地开辟了中文版页面&＃xff1a;

在官方wiki中也专门有个页面&＃xff0c;讲述如何参与中文翻译相关贡献&＃xff1a;

在知乎专栏上也有篇文章&＃xff0c;详细描述了“如何从 0 到 1 参与 Flink 社区”&＃xff1a;

贡献首个commit的经验教训

完成首个commit的贡献后&＃xff0c;明哥确实有几个经验教训跟小伙伴们分享下。

第一个经验&＃xff1a;主动沟通&＃xff0c;遇到问题积极寻求帮助。大家可以看到&＃xff0c;我这个jira因为长时间没有更新处于了“ stale-assigned”状态&＃xff0c;这其实是因为明哥对社区pr流程不太熟悉&＃xff0c;虽然很早就完成了相关的翻译工作&＃xff0c;Pull-request也早就available了&＃xff0c;但没有主动联系社区相关人员进行review&＃xff0c;而没有review过的代码&＃xff0c;哪怕只是文档或中文翻译相关的修改&＃xff0c;社区都不会merge到master主分支的。所以在社区进行合作时&＃xff0c;我们要主动沟通&＃xff0c;遇到问题积极寻求帮助。

第二个经验&＃xff0c;需要熟悉git相关流程和命令&＃xff0c;以及社区在这块的规范。比如在自己私有仓库的分支中修改完代码后&＃xff0c;需要基于master分支的最新代码进行rebase&＃xff08;而不是merge&＃xff01;&＃xff01;&＃xff09;&＃xff0c;比如commit时要归并为一个commit且comment要符合社区规范。

在此着重感谢下Jark Wu Jark 老师&＃xff0c;和Jingsong Lee 之信老师&＃xff0c;正是在你们的帮助下&＃xff0c;我才成功完成了首个commit, 谢谢&＃xff01;

git相关干货

最后来点git相关干货&＃xff0c;供大家参考。其实git官网有更详细的资料&＃xff0c;网上也有不少不错的博客&＃xff0c;大家可以查阅。我这里仅仅列出一些自己本次commit中需要注意的命令和一些小技巧汇总给大家。

git push远程分支前&＃xff0c;需要先 rebase到最新的apache master分支&＃xff1a;

git checkout master
git pull apache master
git log --oneline -5
git checkout FLINK-18199
git rebase master
git log --oneline -5
或者&＃xff1a;
git checkout FLINK-18199
git status
git log --oneline -5
git pull --rebase apache master
git log --oneline -5


git push 到远程仓库之后&＃xff0c;如果需要回滚&＃xff08;撤销&＃xff09;代码改动&＃xff0c;操作步骤如下&＃xff1a;

1. git log 查看提交日志&＃xff1b;然后 git reset --hard 版本号 回滚到特定提交&＃xff1b;
2. git pull apache master: 拉取社区最新版本&＃xff1b;
3. git log 查看提交日志&＃xff1b;然后 git cherry-pick commitID : chrry-pick特定的提交&＃xff1b;
4. git push origin master --force: 提交到远程仓库&＃xff1b;
5. create pull request;


相关命令说明&＃xff1a;

git reset –soft 不会改变工作区和stage区&＃xff0c;仅仅将commit回退到了指定的提交 &＃xff1b;
git reset –mixed 不回改变工作区&＃xff0c;但是会用指定的commit覆盖stage 区&＃xff0c;之前所有暂存的内容都变为为暂存的状态 &＃xff1b;
git reset –hard 使用指定的commit的内容覆盖stage区和工作区&＃xff1b;
git reset --soft HEAD^1&＃xff1b;
git revert 是撤销某次操作&＃xff0c;而不是恢复到某个版本&＃xff1b;
git revert 最新版本号 次新版本号... 要回滚的版本号&＃xff08;为避免冲突&＃xff0c;只能一步一步回滚到你想要的版本号&＃xff09;&＃xff1b;
git commit --amend: 提交本次修改&＃xff0c;和上一次的提交合并为一个提交&＃xff0c;并修改comment&＃xff1b;


欢迎大家拥抱开源&＃xff0c;使用开源&＃xff0c;回馈开源&＃xff01;祝大家五一节日快乐&＃xff01;