美文网首页
记一次向reacor-netty提交代码及对review工作的思

记一次向reacor-netty提交代码及对review工作的思

作者: 大哥你先走 | 来源:发表于2021-04-24 09:35 被阅读0次

如何获取贡献的点

  • stackoverflow 网站reactor-nettyreactor-core 标签下的问题,看到有人提问而且问题也在issue列表中,向owner申请解决问题,owner同意后会将对应的issue标记为 help wanted
  • issue列表,可以从issue列表中选择自己可以处理的issue。
  • 阅读文档时发现错误或这发现代码实现和文档不符合,可以提交issue并创建一个PR。
  • 实现代码中标记为todo的功能。

如何让PR顺利merge

  • 首先要向项目的owner认领issue,避免多个人单独解决issue

  • 增加一个新功能:

    • 详细描述新功能/理解他人提出的功能增强需求
    • 设计功能实现方案
    • 和owner一起讨论方案(讨论,修改,讨论......)
    • 编码(功能代码和测试代码)
    • 测试
    • 提交PR等待更多的人review本次PR
  • 修复bug

    • 复现bug(bug不能复现我们也很难解决)
    • 详细描述bug产生的原因及影响
    • 制定bug修复方案
    • 和owner一起讨论bug修复方案(讨论,修改,讨论......)
    • 编码解决(bug修复代码和测试代码)
    • 测试
    • 提交PR等待更多人review本次PR
  • 修复文档错误

    • 描述文档错误或文档和实现不一致的内容
    • 修改文档
    • 提交PR等待更多人review本次PR
  • 处理review意见

    • 理解review意见
    • 和提出人确认review意见及下一步修改方案
    • 重新提交代码或文档

PR 顺利合并的关键是:沟通,沟通,沟通。

困难

个人认为最大的困难是用英语沟通,尤其是口语化的英语更难准确理解他人要表达的意思,Google翻译已经无法满足诉求了。好一点的是,不管你的英语水平怎么样,他们都能理解你要表达的意思。

向开源社区review学习什么?

  • 让最懂的人review代码
  • owner或committer提前参与方案的讨论
  • 看护代码架构,保持代码架构的一致性,摒弃“又不是不能用的”的思想。
  • 看护代码的可扩展性
  • 测试用例也要认真review
  • 注释也是review的重点,保证注释的准确性至关重要。

相关文章

网友评论

      本文标题:记一次向reacor-netty提交代码及对review工作的思

      本文链接:https://www.haomeiwen.com/subject/onukrltx.html