2.4.4 贡献代码和文档
您可以自行修改代码和文档,并通过提交PR将修改合入主干版本。
1. 拉取个人分支
(1)进入docs(文档仓库)或者openGauss-server(代码仓库)。此处以docs(文档仓库)举例。如图2-19所示。
图2-19 docs(文档仓库)
(2) 单击右上角“Forked”按钮,Fork(复刻)个人分支。如图2-20所示。
图2-20 Fork个人分支
2. 修改代码和文档
目前有两种修改代码和文档的方式,Git(分布式版本管理软件)方式修改以及WEB((World Wide Web,即全球广域网,这里指的是在网页上操作)方式修改。
1) Git方式修改
Git方式修改,即在本地通过Git工具将修改一次性提交至远端个人仓库。此方法适用于大量以及批量修改,例如特性更新等场景。
(1) 安装Git。下载Git并按默认设置安装。Git下载地址:Git - Downloads。
(2) 配置Git。
配置Git上的user为您的gitee个人名称。
git config --global user.name "your gitee name"
‚ 配置Git邮箱为您的gitee注册邮箱。
git config --global user.email "your Gitee email"
your Gitee email 为gitee注册邮箱。您可以在gitee个人主页获取。
ƒ 生成SSH公钥。
ssh-keygen -t rsa -C "your Gitee email"
„ 执行如下命令获取公钥。
cat ~/.ssh/id_rsa.pub
“.ssh/id_rsa.pub”为公钥文件保存地址。“id_rsa.pub”为自定义的pub文件名称。
… 在个人Gitee账户中添加您的SSH公钥。如图2-21所示。
图2-21 SSH公钥三方件编译
(3) 复制远程个人仓库至本地。
在个人电脑本地创建文件夹openGauss,存放远程仓库文件。
‚ 在Git工具中执行如下命令复制远程仓库至本地。
# 进入存放个人远程仓库的本地目录openGauss
cd D:\openGauss
# 把远程仓库复制到本地
git clone https://gitee.com/"your Gitee Name"/repository_name #个人远程仓库地址
# 设置本地工作目录的upstream(上行)源
git remote add upstream https://gitee.com/opengauss/docs.git #openGauss远程地址
# 设置同步方式
git remote set-url --push upstream no_push
(4) 修改内容并将本地修改提交至远程个人仓库。
(可选)如果非首次修改本地文件,建议您执行如下操作,使远程仓库与本地仓库保持一致。
在个人仓库页面,单击如下图标将主仓库的内容更新至个人远程仓库。如图2-22所示。
图2-22 更新个人仓库
在本地Git工具执行如下命令,将个人远程仓库内容更新至本地仓库。
git fetch upstream
git merge upstream/master
‚ 进入本地文件夹,修改本地文件。
ƒ 在文件所在目录下打开Git工具,在Git工具中执行如下命令,提交本地修改至个人远程仓库。
如果修改了多个文件夹下的文件,建议依次进入每个子文件夹下面,执行提交操作。
git add .
git commit -m "提交原因"
git push origin master
2) WEB方式修改
WEB方式修改,即直接在web网页上修改Markdown文件,适用于内容较少的修改。例如维护版本的日常问题处理。
(1) 进入个人Fork路径,单击“Web IDE(integrated development environment,集成开发环境)”。如图2-23所示。
图2-23 Web IDE
(2) 在左侧导航栏找到对应文件进行编辑。
(3) 修改完成后,单击顶部“Markdown预览”检查修改内容。
(4) 提交。先单击
保存修改,填写修改原因后提交到当前分支。如图2-24所示。
图2-24 提交
3. 提交PR
提交PR可以将远程个人仓库的修改合并至主干中。
(1) 进入个人Fork路径,检查修改的内容是否已合入。如图2-25所示。
图2-25 合入信息
(2) 在“Pull Requests”页面单击“+新建Pull Request”。
(3) 输入修改的详细信息,并单击“创建”。如图2-26所示。
图2-26 创建
(4)提交完成等待committer(代码提交者)审核后合入。