CodeGuide 贡献指南

2021年10月24日，`小傅哥` 的文章全部开源到代码库 [`CodeGuide`](https://github.com/fuzhengwei/CodeGuide) 中，与同好同行，一起进步，共同维护。

我自己的个人精力毕竟有限，经常需要对粉丝伙伴对文章的提问进行处理，但随着文章越来越多，可分配的时间越来越少，维护的效率会有所下降，因此希望大家可以共同参与到 CodeGuide 的维护中。**维护这样一个 6.2k star 的项目还是非常有意义的**

## 如何参与到项目的维护呢？

这里我提供 3 种方式：

1. **提出 `Issue`** ：在 Issue 中指出你觉得需要改进/完善的地方(能够独立解决的话，可以在提出 Issue 后再提交 `PR` )。
2. **处理 `Issue`** : 帮忙处理一些待处理的 `Issue`。
3. **提交 `PR`**： 对于错别字/笔误这类问题可以直接提交`PR`，无需提交`Issue` 确认。

### 提出 Issue

1. 点击项目右上角的 [`New Issue`](https://github.com/fuzhengwei/CodeGuide/issues) 按钮，就可以创建一个新的 `Issue` 了。
2. 在 `Issue` 中，你需要写清楚自己遇到的问题，例如：你觉得哪里需要改进，或者你觉得还可以添加哪些内容。


例如：一位同学在学习 `CodeGuide` 的过程中，发现面经手册中关于 HashMap 数据迁移描述性问题，于是提出了这个 `Issue`。

### 处理 Issue

如果你发现一些**待处理** 的 `Issue` 的话，可以帮忙解决。

我会把一些 **待处理** 的 `Issue` 标记出来，如果你想帮忙解决这个 `Issue` 的话，直接在 `Issue` 区回复一下自己想要帮忙处理即可。

### 提交 PR

首先，`CodeGuide` 仓库是属于 `fuzhengwei` 账户的，因此我们无权对其进行修改。所以首先，我们需要 `Fork` 原仓库，到自己的账户名下。

例如，点击 `Fork` 后，在自己账户下自动生成的仓库。

然后，我们就可以自由的对自己的仓库进行修改，编写相关内容了～因为该仓库是原仓库的复制品，所以不论你对其做什么修改，都不会影响到原仓库！

在对自己的仓库修改完毕后，你就可以向原仓库提交 `Pull Request`，也就是合并请求了。

**那么具体该如何操作呢？**

你在自己 `Fork` 的项目中，点击 `Pull Request`，然后点击 `New Pull Request`


然后,根据提示，创建 `Pull Request` 即可。是不是非常简单?


**另外你还可以直接在阅读文章的时候，直接点击 `在 GitHub 上编辑此页`** 这样也可以在已经 Fork 代码库的前提下，提交 PR，是不是很方便！

接下来，你只需要等待原仓库管理员的审核就可以了。

在收到你的 `Pull Request` 后，原仓库管理员可以决定是否合并你的提交，如果同意合并的话，你的贡献就能真正融入原项目了！

## 总结

对于提交 PR 的小伙伴来说：

1. 解决 Issue 的过程中，你会加深自己对某个知识点的理解。
2. 如果你的 `PR` 被采纳，你的贡献将会永久保留在 `CodeGuide` 上，你也会成为 `CodeGuide` 的 `Contributor`。

**我真心希望有更多可以参与到 CodeGuide这个项目的维护中，我们大家都能有所收获！**