如何飞速成为开源贡献者(Contributor)

淩亂°似流年 2023-10-15 12:32 84阅读 0赞

#### 如何飞速成为开源贡献者Contributor ####

*  一、环境信息
 *   *  1.1 硬件信息
     *  1.2 软件信息
 *  二、Git安装
 *   *  2.1 Git介绍
     *  2.2 Git下载安装
 *  三、开源项目选定
 *  四、GitHub参与开源流程
 *   *  4.1 Fork项目
     *  4.2 SSH配置
     *   *  4.2.1 为什么要配置SSH
         *  4.2.2 如何配置SSH
     *  4.3 Clone项目
     *  4.4 IDEA关联
     *  4.5 PR生成
     *  4.6 PR提交

## 一、环境信息 ##

### 1.1 硬件信息 ###

1.  **型号** ：MacBook Pro
2.  **内存** ：16GB
3.  **硬盘** ：512GB SSD
4.  **处理器** ：Apple M2
5.  **宿主机CPU架构** ：ARM

### 1.2 软件信息 ###

1.  **Git版本** ：2.39.2 (Apple Git-143)
2.  **Maven版本** ：3.8.8
3.  **JDK版本** ：17

## 二、Git安装 ##

### 2.1 Git介绍 ###

Git 是一个**分布式版本控制系统**，用于管理和跟踪文件的变化。它可以帮助开发人员或团队**追踪代码的修改历史、协同开发、管理各个版本的代码**，并提供了**回滚、分支管理、合并**等功能。  
使用 Git，开发人员可以在不同的分支上独立工作，然后将各自的修改合并到主分支上，以便保持代码的整洁和可维护性。Git 是开源的，易于安装和使用，因此被广泛应用于软件开发和其他版本控制的场景中。  
![在这里插入图片描述][92f2d333042d4d7fb2f20ec6a37cc03d.jpeg]

### 2.2 Git下载安装 ###

> 直接参考 git 官方网站：https://git-scm.com/

![在这里插入图片描述][4e233568daeb4c39beb410a5e7ccd349.png]

## 三、开源项目选定 ##

> 乙真仙人选定的是[Apache Doris][]

Apache Doris 是一个基于 **MPP 架构的高性能、实时的分析型数据库**，以极速易用的特点被人们所熟知，仅需亚秒级响应时间即可返回海量数据下的查询结果，不仅可以支持高并发的点查询场景，也能支持高吞吐的复杂分析场景。  
基于此，Apache Doris 能够较好的满足**报表分析、即席查询、统一数仓构建、数据湖联邦查询加速**等使用场景，用户可以在此之上构建**用户行为分析、AB 实验平台、日志检索分析、用户画像分析、订单分析**等应用。  
![在这里插入图片描述][21f08fdeeb2b411fb3d6f3c5d0097f7f.png]

## 四、GitHub参与开源流程 ##

### 4.1 Fork项目 ###

> 在GitHub中，“fork” 指的是将别人的代码库复制到自己的账户下，并在独立的分支上进行修改和扩展的行为。  
> 当你在GitHub上找到一个你感兴趣的项目，并希望对其做出改进、贡献或者使用它作为自己项目的基础时，你可以选择将该项目进行fork。这将在你的GitHub账户下创建一个原项目的副本，包含了所有的代码、历史记录和分支。  
> 在你进行分叉后，你便可以在自己的项目副本上自由地进行修改和实验，而不会影响原项目的稳定性和功能。你可以添加新的特性、修复问题、优化代码，或者根据自己的需求进行个性化定制。  
> fork之后，你可以将你的修改提交回原项目，这就是所谓的"pull request"（合并请求）。原项目的维护者将会审核你的更改，并决定是否接受你的修改并将其合并到原项目中。  
> 通过这种方式，**fork功能为开源社区提供了一种协作的方式**，使得项目能够从众多贡献者的力量中受益。

1.点击fork  
![在这里插入图片描述][95828be4c14342a29c9b9117266f26c1.png]2.创建fork  
![在这里插入图片描述][21ae20cf9aee4c84b025cea30f16647a.png]  
3.查看fork  
![在这里插入图片描述][3b020781fe194721b32546f8c6f913a5.png]

### 4.2 SSH配置 ###

#### 4.2.1 为什么要配置SSH ####

git clone支持https和git（即ssh）两种方式下载源码：  
![在这里插入图片描述][72f6abb216644582ac079a9b7dde246a.png]  
当使用git方式下载时，如果没有配置过ssh key，则会报如下错误提示：  
![在这里插入图片描述][a1b37a3904904158905d0119b5653251.png]

#### 4.2.2 如何配置SSH ####

1.首先用如下命令（如未特别说明，所有命令均默认在Git Bash工具下执行）检查一下用户名和邮箱是否配置（github支持我们用用户名或邮箱登录）：

git config --global  --list 
    
    # 如下图所示，说明还没配置

![在这里插入图片描述][d28866894e744f069ea27396492c9717.png]

2.配置用户名和邮箱（如已配置则跳过）

# 可以在自己github的Settings中找到
    git config --global  user.name "这里换上你的用户名"
    git config --global user.email "这里换上你的邮箱"

3.再次检查用户名和邮箱（如已检查成功则跳过）

git config --global  --list 
    
    # 如下图所示，说明配置成功

![在这里插入图片描述][20386e75adcc4483bf03866582a01199.png]

4.生成秘钥

# 执行命令后需要进行3次或4次确认(可以一路回车)
    ssh-keygen -t rsa -C "这里换上你的邮箱"
    
    # 结果如下图所示，记住红框内id_rsa.pub文件路径，后续需要配置到github上

![在这里插入图片描述][971deac05d01484d921a30e382dd147b.png]

5.打开你的github，进入Settings配置页  
![在这里插入图片描述][e677bc2fb99744b69ecb5cfef3bc508a.png]

6.选择SSH and GPG keys项并新增  
![在这里插入图片描述][1570ee4891de4c5aa05151a682b7d6a6.png]  
7.将id\_rsa.pub的内容填入Key中并Add

> 至此ssh就配置完成了  
> ![在这里插入图片描述][166415e441544bf280ae518ed29ac416.png]

### 4.3 Clone项目 ###

> SSH配置完成后，再次进行Clone就可以正常下载了

git clone git@github.com:yz-jayhua/doris.git

![在这里插入图片描述][12230ede43cd4bad97ad1f09297c47c5.png]

### 4.4 IDEA关联 ###

1.打开clone的项目  
![在这里插入图片描述][529722aa08e24067b276fdc126708ecd.png]

2.打开Settings并搜索git  
![在这里插入图片描述][b3e6888ac4194c2bb891b43533b379e5.png]

3.点击测试让idea自动匹配并应用  
![在这里插入图片描述][9050df0b4b8b41cc832ca031f7e0ced5.png]

### 4.5 PR生成 ###

> 来个简单的文档PR体验一把：修改一个文档的错别字

1.定位修改文件

> 查阅官方文档时发现如下一个错别字，对应官方文档的地址：[DATETIME][]

![在这里插入图片描述][ade163eda4094e9e8c6f560b99b981a9.png]

2.从master新建一个分支去修改  
![在这里插入图片描述][7b7f4076891f462a97a8645537209145.png]

3.分支命名并创建  
![在这里插入图片描述][68f99a3dbbf44ccf8b4daa26698225b5.png]

4.创建后自动切换分支  
![在这里插入图片描述][db24e60d5e2e4ee4929464bf069af785.png]

5.提交代码到本地仓库

> Commit Message参考：  
> fix：表示该提交用于修复错误或问题。  
> feat：表示该提交用于添加新功能。  
> docs：表示该提交用于更新文档。  
> style：表示该提交用于代码格式化或结构调整。  
> refactor：表示该提交用于代码重构，不添加新功能或修复错误。  
> perf：表示该提交用于提高性能。  
> test：表示该提交用于测试代码。

![在这里插入图片描述][00f767cd35034cf0ab5d4115ba967067.png]

6.推送代码至github仓库上  
![在这里插入图片描述][dbc9a60c1afd4c0badff53175b88fe22.png]

7.PR生成确认

> 此时刷新github个人仓库对应的项目时，会出现PR请求，即说明PR生成成功

![在这里插入图片描述][18a937a4fb604e3e9b4b4275a76bceff.png]

### 4.6 PR提交 ###

1.点击【Compare & pull request】并创建PR  
![在这里插入图片描述][df469b6cbcb84b9fa6c11d51cee85f5d.png]

2.提交结果确认

> 提交后会生成相关的pr编号，后续流程如下：
> 
> 1.  会有社区小伙伴进行review（Apache Doris目前需要2位小伙伴review后才可进行下一步，不同的项目要求不同）
> 2.  review完成并确认后会开始跑流水线，即自动对项目进行各种规则检测
> 3.  流水线全部跑完后，会有社区的负责人进行合并**Merge**
> 4.  合并成功后，恭喜你成为**Apache Doris贡献者(Contributor)**

![在这里插入图片描述][cc667fbe589444bd8fd14693d51e9990.png]  
![在这里插入图片描述][9ca3d5ccb8da458787cb27020674a2bc.png]

**至此，你已飞速成为开源贡献者(Contributor)啦～查阅过程中若遇到问题欢迎留言或私信交流。**

[92f2d333042d4d7fb2f20ec6a37cc03d.jpeg]: https://img-blog.csdnimg.cn/92f2d333042d4d7fb2f20ec6a37cc03d.jpeg
[4e233568daeb4c39beb410a5e7ccd349.png]: https://img-blog.csdnimg.cn/4e233568daeb4c39beb410a5e7ccd349.png
[Apache Doris]: https://github.com/apache/doris
[21f08fdeeb2b411fb3d6f3c5d0097f7f.png]: https://img-blog.csdnimg.cn/21f08fdeeb2b411fb3d6f3c5d0097f7f.png
[95828be4c14342a29c9b9117266f26c1.png]: https://img-blog.csdnimg.cn/95828be4c14342a29c9b9117266f26c1.png
[21ae20cf9aee4c84b025cea30f16647a.png]: https://img-blog.csdnimg.cn/21ae20cf9aee4c84b025cea30f16647a.png
[3b020781fe194721b32546f8c6f913a5.png]: https://img-blog.csdnimg.cn/3b020781fe194721b32546f8c6f913a5.png
[72f6abb216644582ac079a9b7dde246a.png]: https://img-blog.csdnimg.cn/72f6abb216644582ac079a9b7dde246a.png
[a1b37a3904904158905d0119b5653251.png]: https://img-blog.csdnimg.cn/a1b37a3904904158905d0119b5653251.png
[d28866894e744f069ea27396492c9717.png]: https://img-blog.csdnimg.cn/d28866894e744f069ea27396492c9717.png
[20386e75adcc4483bf03866582a01199.png]: https://img-blog.csdnimg.cn/20386e75adcc4483bf03866582a01199.png
[971deac05d01484d921a30e382dd147b.png]: https://img-blog.csdnimg.cn/971deac05d01484d921a30e382dd147b.png
[e677bc2fb99744b69ecb5cfef3bc508a.png]: https://img-blog.csdnimg.cn/e677bc2fb99744b69ecb5cfef3bc508a.png
[1570ee4891de4c5aa05151a682b7d6a6.png]: https://img-blog.csdnimg.cn/1570ee4891de4c5aa05151a682b7d6a6.png
[166415e441544bf280ae518ed29ac416.png]: https://img-blog.csdnimg.cn/166415e441544bf280ae518ed29ac416.png
[12230ede43cd4bad97ad1f09297c47c5.png]: https://img-blog.csdnimg.cn/12230ede43cd4bad97ad1f09297c47c5.png
[529722aa08e24067b276fdc126708ecd.png]: https://img-blog.csdnimg.cn/529722aa08e24067b276fdc126708ecd.png
[b3e6888ac4194c2bb891b43533b379e5.png]: https://img-blog.csdnimg.cn/b3e6888ac4194c2bb891b43533b379e5.png
[9050df0b4b8b41cc832ca031f7e0ced5.png]: https://img-blog.csdnimg.cn/9050df0b4b8b41cc832ca031f7e0ced5.png
[DATETIME]: https://doris.apache.org/zh-CN/docs/dev/sql-manual/sql-reference/Data-Types/DATETIME
[ade163eda4094e9e8c6f560b99b981a9.png]: https://img-blog.csdnimg.cn/ade163eda4094e9e8c6f560b99b981a9.png
[7b7f4076891f462a97a8645537209145.png]: https://img-blog.csdnimg.cn/7b7f4076891f462a97a8645537209145.png
[68f99a3dbbf44ccf8b4daa26698225b5.png]: https://img-blog.csdnimg.cn/68f99a3dbbf44ccf8b4daa26698225b5.png
[db24e60d5e2e4ee4929464bf069af785.png]: https://img-blog.csdnimg.cn/db24e60d5e2e4ee4929464bf069af785.png
[00f767cd35034cf0ab5d4115ba967067.png]: https://img-blog.csdnimg.cn/00f767cd35034cf0ab5d4115ba967067.png
[dbc9a60c1afd4c0badff53175b88fe22.png]: https://img-blog.csdnimg.cn/dbc9a60c1afd4c0badff53175b88fe22.png
[18a937a4fb604e3e9b4b4275a76bceff.png]: https://img-blog.csdnimg.cn/18a937a4fb604e3e9b4b4275a76bceff.png
[df469b6cbcb84b9fa6c11d51cee85f5d.png]: https://img-blog.csdnimg.cn/df469b6cbcb84b9fa6c11d51cee85f5d.png
[cc667fbe589444bd8fd14693d51e9990.png]: https://img-blog.csdnimg.cn/cc667fbe589444bd8fd14693d51e9990.png
[9ca3d5ccb8da458787cb27020674a2bc.png]: https://img-blog.csdnimg.cn/9ca3d5ccb8da458787cb27020674a2bc.png