优化 GitHub 上的项目工作：熟悉 Github 模板存储库

大家好，JavaRush 社区！今天我们将讨论开源以及除了编写的代码之外优化 GitHub 上的项目工作：Github 模板存储库简介 - 1

创建高质量项目所需的条件。编写一个有用的产品很重要。但同样重要的是存储库（GitHub 上的项目存储库）的正确设计。这将有助于实现另一个关键点——产品推广。即使这个项目超级酷，但如果它设计得很差，至少在自述文件中没有描述（你可以在这里阅读自述文件是什么），没有注明许可证等等，就不会成功。只是没人会注意到他。如果有人注意到，他们将不知道如何与他互动。有很多东西需要一遍又一遍地填写，对于程序员来说每次复制粘贴并不容易，而正是为了这个，今年夏天，GitHub 发布了Template Repository功能来帮助解决这个问题。可以说，自动化创建新项目的过程。今天我们将了解什么是存储库以及什么是模板存储库。我们将描述项目中除了代码之外还应该有什么，需要关注什么。让我们从头开始创建一个模板存储库，并添加我认为必要的所有内容。最后，我们将在创建新存储库时使用模板存储库。但首先，让我们了解一下这些术语。

存储库类似于 GitHub 中项目的文件夹。存储库包含属于该项目的所有文件。它存储了项目变更的整个历史记录，这一点非常重要。

使用“问题”选项卡，您可以为项目创建缺陷、改进和问题。

使用项目，您可以创建看板来跟踪问题的状态、其实施和规划。

模板存储库是您可以基于其创建新存储库的模板。包含所有存储库的通用代码的模板。

理论：任何项目的通用存储库中应该包含什么优化 GitHub 上的项目工作：Github 模板存储库简介 - 2

GitHub 上的每个开源项目都应该有一个详细描述的社区简介，其中包含以下元素。

1. 问题模板

在这里，您需要描述在存储库中创建问题的规则：它们应该被称为什么，标签是什么，谁将被分配给它。创建新问题时，将提供以下选项：

错误报告- 创建问题来描述项目中的缺陷；
功能请求- 项目新想法的提案；
改进请求——对项目的改进建议；
自定义问题模板- 如果其他选项不起作用，您可以使用空模板。

可以在此处查看其外观的示例。

2. 许可证

编写项目所依据的许可证。有必要让那些使用该项目的人知道什么是有保证的，什么是没有保证的。例如，Apache 许可证 2.0规定如下：优化 GitHub 上的项目工作：熟悉 Github 模板存储库 - 3

3.自述文件

这是该项目的描述，它的名片。关于该项目需要说明的所有内容都应该在这里。当然，考虑到项目的具体情况，每次都需要对其进行描述，但标题是相同的。例如：

概述——项目的简要描述；
使用 - 如何使用该项目；
建设——如何启动一个项目，需要什么；
故障排除 - 这描述了您可能遇到的问题以及如何解决这些问题；
发行说明 - 根据版本进行更改的说明；
作者——不要忘记你所爱的人；
贡献 - 描述您如何参与项目的开发；
行为准则 - 参与规则的描述；
RELEASE_NOTES - 记录新版本的所有更改的文件。最好将其放在单独的文档中并在自述文件中存储链接；
CONTRIBUTING是一个文件，描述您如何为该项目的开发做出贡献。为 README 中的 Contributing 标头制作一个单独的文件；
CODE_OF_CONDUCT - 描述参与项目开发的规则的文件；
拉取请求模板- 供创建拉取请求的人使用的模板。

所有这些东西都在不同的项目中使用，无论编程语言或其具体细节如何。

练习：创建自己的模板

正如他们所说，让我们从言语转向行动。现在，我将通过一个示例向您展示如何创建自己的模板。

您首先需要在 GitHub 上拥有一个帐户/在那里注册。
创建新存储库：为此，请单击右上角的 +
创建时填写：
- 存储库名称 - 在我的例子中存储库模板；
- 描述——项目的简要描述；
- 我们离开公共，尽管您可以选择私人；
- 检查 README 初始化框：
- 选择项目将遵循的许可证：
  
  由于就我而言，模板是通用的，因此不需要 gitignore：它将针对特定项目和编程语言添加。
  
  因此，点击Create Repository，从而完成创建过程。系统会自动带我们到新创建的存储库。
填写社区资料：在创建的存储库中，转到“见解”选项卡并选择“社区”：

如您所见，剩下的就是填写行为准则、贡献、问题模板、拉取请求模板。

使用行为准则示例，我们将展示如何将它们添加到项目中。

点击添加，系统提示您选择贡献者契约或公民行为准则：

我选择第一个并单击Review and Submit。

接下来，您可以编辑该文件并提交它。

在底部，选择直接提交到主分支选项，然后单击提交新文件：

因此，如果我们返回社区简介，我们会发现行为准则被标记为已添加：

Contributing 和 Issue Template 的添加方式类似，所以我就不展示了。自己做 ;）
添加拉取请求模板。

但我们将单独讨论这个问题。

我不知道为什么 GitHub 没有添加同样方便的选项来设置 Pull-Request 模板，所以你必须研究文档并手动添加。

为此，请单击存储库根目录中的“创建新文件”：

文件名应为：.github/pull_request_template.md。

我们将需要的内容添加到模板中，然后单击“提交新文件”，就像我们上面所做的那样。我不打算重新发明轮子，而是找到了一个对我来说似乎非常有用的例子。

这样整个社区资料将被填写：
添加模板存储库标记。

为此，请转到存储库中的“设置”选项，然后选中“模板存储库”框：

就这样，创建新项目的模板就准备好了。这样，当我们将来需要创建新项目时，就会节省大量时间。这也将帮助您不错过重要的细节，因为您经常忘记添加某些内容，例如许可证或问题的清晰模板。