面向开源社区的git工作流简介

前言

最近两个月在给kubeedge社区提交PR,发现自己学的git知识不能很好解决几乎不能解决在提交PR和修改PR遇到的各种问题,所以写一篇博客来记录一下如何给一个开源社区提交PR

工作流

image

这里借用kubernets社区提供的工作流示意图。

如果我们想提交一个PR,具体需要:

  • fork官方的repo
  • clone到本地
  • 创建自己的工作分支
  • 保持分支同步
  • 本地 add 并且 commit自己的工作
  • push到github
  • 在自己的repo上创建PR到仓库

之后等待社区成员的review并根据review意见修改自己的工作内容

TIPS

一个分支对应的是一个feature, 也就只能提交一个PR,如果你想提交多个PR,请创建额外的分支

如果你在一个PR中commit了不属于这个PR的内容,请参考:
https://stackoverflow.com/questions/39459467/remove-a-modified-file-from-pull-request

部分文件的版本回退,请参考:
https://blog.csdn.net/panweiwei1994/article/details/78501371

commit的时候加上-s选项添加个人用户名和邮箱信息

参考

本博客参考kubernets社区的贡献者文档

refer:
contributor-cheatsheet
github-workflow