前置知识
- 官方仓库
- 官网
- SIG:openGauss 社区按照不同的 SIGs(Special Interest Groups)来组织,以便于更好的管理和改善工作流程。 SIG 是开放的,欢迎任何人加入并参与贡献。每一个 SIG 在码云(Gitee)上拥有一个或多个代码仓库。 您可以在 SIG 对应的代码仓库上提交 Issue,参与 Issue 讨论,提交 Pull Request,参与代码检视等。
- 官方参考文档
步骤
注册Gitee
在开始贡献前,您需要先注册一个Gitee账号,如果您已有账号可跳过这步。
在码云官网注册账号演示如下:
- 找到注册入口
- 填写个人信息,此步可关联其他账号
- 在个人主页完善个人信息,注意记得选择常用邮箱
签署CLA
CLA是openGauss社区贡献者许可协议,在进行社区贡献时openGauss会自动检查贡献者是否签署CLA。
- 点击CLA链接进入签署页面
- 选择签署个人协议
- 下拉到底后填写个人信息,注意,此时填写的邮箱必须与Gitee账号设置的邮箱相同
选择需要做出贡献的SIG
openGauss的不同SIG在Gitee中有不同的仓库,在做出贡献时需要找到对应的SIG和对应的仓库,最新SIG可在官网查看,当前(2023/11/15)最新SIG如下
开始贡献
openGauss的贡献范围很广,例如:
-
提交issue
-
提交PR
-
审核PR
-
文档英文化
-
贡献经验(提交博客)
-
....
在不同SIG中可以看到该SIG的贡献范围,本文将以对docs文档提交一个fix类型的PR为例。
1.Fork到个人仓库
2.查看仓库链接
3.使用Git拉取仓库到本地
git clone url
4.在本地修改文件
5.提交新版本到个人远程仓库
git add .
git commit -m "commit_message"
git push origin master
注意:commit_message不要使用无关信息,最好简短描述您做出的修改
6.查看是否提交成功
7.提交PR
8.填写相关信息
9.后续根据机器人opengauss_bot和项目相关人员的评论修改PR即可
查看贡献
贡献被审核通过后,可以通过代码仓库和官网查看相关信息。
后话
这是本人第一个参与贡献的开源项目,本文亦不如官方指导文档详细,如有不足还请斧正。