JavaGuide 贡献指南

[Snailclimb]

3 月份的时候，JavaGuide 这个项目的 star 数量达到了 100K ，为此，我专门写了一篇文章来复盘一下：《1049 天，100K!简单复盘！》 。

随着看这个项目的小伙伴越来越多，各种 Issue 也越来越多，有勘误的，也有提交需求的。但是，我自己的个人精力毕竟有限，经常有一些 Issue 我自己无法及时处理。

目前的频率是我一周会抽出 2 到 3 天 专门来处理小伙伴们的 Issue 和 PR。下图是我的 2017~2021 的 Github 提交记录。

为了让 JavaGuide 的 Issue 得到更快速的处理，同时也是为了让更多小伙伴参与到 JavaGuide 这个项目，我最终决定还是发出这篇求助帖。

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

这里我提供 3 种方式：

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

提出 Issue

如果你在学习 JavaGuide 的过程中，发现了需要改进的地方，或者你想为 JavaGuide 添加更多的内容的话，你可以提交 Issue。

具体步骤如下：

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

例如，下面就是一个具体的例子：一位同学在学习 JavaGuide 的过程中，发现缺失了操作系统中的死锁部分存在问题，于是提出了这个 Issue。下面有另一位同学认领了这块部分，并且随后为 JavaGuide 添加了死锁相关内容。

你可以仿照已有的 Issue，编写自己的 Issue 内容。

在 Issue 内，你可以和大家共同探讨所遇到的问题以及合适的解决方案。探讨完毕后，就可以开始真正为项目作出贡献了！

处理 Issue

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

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

涉及到内容修改/完善的话，你需要提交 PR。

提交 PR

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

点击上图的 Fork 按钮后，Github 就会自动为仓库创建一份副本，到自己的账户名下。

例如，上图就是我点击 Fork 后，在自己账户下自动生成的仓库。

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

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

那么具体该如何操作呢？

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

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

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

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

总结

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

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

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

[WT-AHA]

现在 pr 被合并之后在 contributor 列表中还会显示吗

[Snailclimb]

现在 pr 被合并之后在 contributor 列表中还会显示吗

会显示。

[WT-AHA]

那为啥在 contributor 列表中没有俺

[Snailclimb]

那为啥在 contributor 列表中没有俺

我在那篇文章文首提到了你，contributor 列表或许是延迟的问题？我也感觉挺奇怪的。

[WT-AHA]

好的

[ddmcc]

contributor中俺没了😭

[panyu787]

@Snailclimb 博主你好，我把javaGuide 原仓库 Fork到自己的账户名下，之后我用什么软件打开？用intelij idea打开吗？ 提交自己的修改记录。在本地怎么启动javaGuide 项目？怎么预览自己修改之后的内容？

[Snailclimb]

@Snailclimb 博主你好，我把javaGuide 原仓库 Fork到自己的账户名下，之后我用什么软件打开？用intelij idea打开吗？ 提交自己的修改记录。在本地怎么启动javaGuide 项目？怎么预览自己修改之后的内容？

直接使用Markdown编辑工具打开即可，例如 Typora、MarkText 。如果不是新增文章的话，不需要本地运行就可以，因为Markdown编辑工具里就可以直接预览了。