参与开源项目时,提交代码流程是怎样的?


目录

1,提交代码

2,Pull Request合并代码

3,代码规范


Github是常用的代码托管平台,提升团队协作效率功能开发、代码合并、测试发布,分支和标签配合使用,清晰、高效。


常见开源项目代码开发、提交、合并流程如下:

image.png

一,开发测试,提交代码

在实际开发工作中,需要将代码提交和issue关联起来,方便代码检查和功能测试。Github提供了自动关联功能,commit提交代码时只需要在注释中包含issue编号,#issue_id:

image.png

二,Pull Request合并代码

Pull Request是常用的代码提交合并流程流程如下:


1. 创建Pull Request

1) 代码提交后,在页面中点击New pull request按钮

image.png

2) 选择要合并的分支和代码

image.png

3) 点击按钮Create pull request,输入必要的描述信息


2. 合并PR或打回

管理员收到PR后,根据情况处理:

1) 合并代码,如果有冲突,需要解决后再合并。

2) 如果有问题,可以关闭不做任何处理,然后通知开发修复问题。 

image.png

三,代码规范

什么样的代码是好代码?有通用规则,也有详细规范。

1,通用规则

实现功能、健壮、简单、易读、易维护。

2,详细规则

见仁见智,参照一些业界常用规则。

1) 《阿里Java开发手册》https://yq.aliyun.com/articles/69327

2) 《华为Python代码规范》https://bbs.huaweicloud.com/blogs/136797

3) Google代码规范》http://google.github.io/styleguide/


3,反面教材

《垃圾代码19条法则》https://developer.51cto.com/art/202002/611456.htm


猜你喜欢

转载自blog.51cto.com/13851865/2476496