博客 Ding!您有一份ChunJun实用指南,请查收

Ding!您有一份ChunJun实用指南,请查收

   数栈君   发表于 2022-08-24 15:30  92  0

ChunJun是易用、稳定、高效的批流一体的数据集成框架,主要应用于大数据开发平台的数据同步/数据集成模块,使大数据开发人员可简洁、快速的完成数据同步任务开发,供企业数据业务使用。


本文主要整理ChunJun的各类链接以及如何提交pr、Issue的方法,希望大家更好地参与开源,参与社区。


01

ChunJun百科


● 开源地址

GitHub:https://github.com/DTStack/chunjun

Gitee:https://gitee.com/dtstack_dev_0/chunjun


● 官方网站

● 快速入门文档

● 视频课程

● 课件获取

关注公众号“ChunJun”,回复“课件”,即可获得您需要的对应课程的课件。


02

提交pr&Issue指南


ChunJun

如何提交一个优秀的pr

在GitHub上提交pr是参与ChunJun项目开源的一个重要途径,小伙伴们在使用中的一些功能上feature或者bugfix都可以向社区提交pr贡献代码,也可以根据已有的Issue提供自己的解决方案。


● 第一步:fork ChunJun到自己的GitHub仓库

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/f139144acc4834c17cac11f1aa1e4678..jpg

点击fork后就可以在自己仓库中看到以你名字命名的ChunJun项目了:

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/029fdd9d7a56441e4e6177369259f65c..jpg


● 第二步:clone ChunJun到本地IDE

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/f5580dab805a42019794da08c82a535d..jpg


● 第三步:将DTStack/ChunJun设置为本地仓库的远程分支upstream

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/29342e37cee9abcb26e1bd90b9e6d230..jpg


● 第四步:提交代码

任何一个提交都要基于最新的分支 切换分支

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/631e48b6b52b944c55273d3e62dd945d..jpg

本地修改代码后,提交commit

commit_message格式: [commit_type][module] message

commit_type:

feat:表示是一个新功能(feature)

hotfix:hotfix,修补bug

docs:改动、增加文档

opt:修改代码风格及opt imports这些,不改动原有执行的代码

test:增加测试

eg:[hotfix-12345][mysql] Fix mysql time type loses precision.

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/c8f04a242630d1206eaac73080e04a1a..jpg

rebase远程分支

这一步很重要,因为我们仓库中的chunjun代码很有可能已经落后于社区,所以我们 push commit前需要rebase,保证我们的commit是基于社区最新的代码,很多小伙伴没有这一步导致提交的pr当中包含了其他人的commit

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/9fbd243900053bd31d68d263ea13c43a..jpg

rebase后有可能出现代码冲突,一般是由于多人编辑同一个文件引起的,只需要根据提示打开冲突文件对冲突部分进行修改,将提示的冲突文件的冲突都解决后,执行

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/5620896c019fb47c2d5ebfbb755bf1e9..jpg

依此往复,直至屏幕出现类似rebase successful字样即可

rebase之后代码可能无法正常推送,需要git push -f 强制推送,强制推送是一个有风险的操作,操作前请仔细检查以避免出现无关代码被强制覆盖的问题

push到github仓库

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/086c2b9c06472e360fcd164594f0aea0..jpg


● 第五步:提交pr

以我修复kafka写入过程中出现空指针问题为例,经过步骤四我已经把代码提交至我的仓库master分支

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/ad335b973f8f538aabade0fba03673c3..jpg

进入ChunJun仓库页面,点击Pull Request

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/1013dbcfcb0071e54e99c605e50cf023..jpg

选择head仓库和base仓库以及相应的分支

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/96f34fbe7933e5217b82b3356b9b88b0..jpg

填写pr信息,pr信息应该尽量概括清楚问题的前因后果,如果存在对应Issue要附加Issue地址,保证问题是可追溯的

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/52e2ecf2bf06eceff1189acbfa9d49bc..jpg
http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/399a28b56703b8a1f5b47796316ebada..jpg

pr提交成功后需要一段时间代码review,您可以耐心等待一下我们review后合入,或者直接联系我们,提交pr的同学更有机会加入我们共创小组。


ChunJun

如何正确进行pr review

  //  

● pr review

• 如果是简单的代码或者文档改动,review 结束可以直接合并

• 如果是较大的内容改动,需要对应模块owner review

• 如果是功能分支,需要pr中提供设计思路,有必要的情况下,提供设计文档

• pr 回复时间不能超过一周

• 不符合规范的pr 在回复提示过后仍未改动,不予合并,一周之后关闭


● review pr 的要求

• 在pr里备注修复的issue

• pr commit 模版[hotfix-#issueID][#fix-module] #fix-commit.

• 修改内容尽量保持与issue内容一致,如果出现无关修改,在pr中备注出来

• review 代码时注意代码格式化


ChunJun

如何正确提出一个Issue

issue是一种非常好的可沉淀、可复现、可跟踪的交流方式,如果您发现了ChunJun有任何bug或奇怪的性能特征,请在GitHub或Gitee中提交新的Issue。


目前我们团队主要在GitHub上解决Issue和pr相关内容,Gitee上会相对慢一些,大家如果有Issue或者pr尽量在GitHub上提出,我们会及时处理。


● 在 GitHub 上提交的新 Issue 分为以下几种:

• 反馈错误 (Bug Reports)

• 提交新需求 (Feature Requests)

• 常规问题 (General Questions)

• 性能问题 (Performance Questions)


● 进行高效提问的方法

请您详细描述存在问题+问题截图,提交到ChunJun的Issue,以便我们迅速定位问题并作出回应。

Issue地址:

https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FDTStack%2Fchunjun%2Fissues%2Fnew%2Fchoose


不了解如何高效进行提问的同学,请阅读下面两篇文章:

《提问的智慧》:

https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md

《社区提问指南》:

https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md


● 提交Issue需要注意的地方

提交的Issue 最好带上详细的复现问题的步骤,这样可以减少其他同步复现问题的时间,更快更有效地解决问题。


如果能定位到源码的问题,建议提交一个pr来修复它,而不是等待其他同学。


03

社群交流技巧


除了GitHub和Gitee之外,我们还有一个拥有3000多人的开源框架技术交流群,在群内,大家可以尽情交流ChunJun相关技术和资讯,各位开发者们互帮互助,一串代码、一个建议,都是对ChunJun的莫大帮助。


开源框架交流钉钉群号码:30537511

http://dtstack-static.oss-cn-hangzhou.aliyuncs.com/2021bbs/files_user1/article/33eb8a1e8d35db7e36506fd8e1d57474..jpg


对于社群,我们希望它能够成为一个所有对开源、对ChunJun有兴趣的朋友的交流场所,而不是一个单纯的答疑群。在群里,不论是ChunJun团队成员还是你们,所有人的角色都是ChunJun的爱好者和共建者,而不是“客服”“机器人”这样的角色。


当您对于ChunJun有疑问时,我们首先推荐您搜索相关文档,如果不能得到答案,强烈建议您通过提交Issue和我们进行沟通,最后才是在社群内提问。因为通过提交Issue的方式,问题可以得到沉淀,社群内消息刷新得很快,一个不小心,您的问题就石沉大海了。


我们团队成员平时还有自己的工作,没办法守在电脑前一个个回复社群中的问题,所以勇敢地提出 Issue吧,那一刻,你就已经变成了开源项目的参与者!


ChunJun团队也将根据大家的反馈,定期更新迭代官方文档,不断完善项目质量,和你们一起共建ChunJun。

0条评论
社区公告
  • 大数据领域最专业的产品&技术交流社区,专注于探讨与分享大数据领域有趣又火热的信息,专业又专注的数据人园地

最新活动更多
微信扫码获取数字化转型资料
钉钉扫码加入技术交流群