有什么可以进入.github“ dot github”目录的概述吗?

我一直在寻找可以放入 GitHub 存储库中的 .github目录的零碎示例。

我可以看到它被用于 GitHub 操作和工作流,以及拉请求和发布模板,但我看不到一个页面概述您可以放在那里与理想的一些文档。我想我也看到了一个资助的例子。

基本上,每次我看到你可以在那里做的事情,我都会想“这很棒,我应该这么做”,但除了例子之外,我看不到其他发现新事物的方法,除了通过例子。

由于这个目录名为 .github,因此它似乎也无视 Google 和 SO 搜索。

21571 次浏览

在 Github 上,文件夹 .github只是一个约定文件夹,用于将与 Github 相关的东西放在其中。Github 处理其中的一些文件,即使您将其放在项目的根目录(例如 ABC1、 CODE_OF_CONDUCT.md)中。因为 Github 不断引入新的特性,所以这些特性都是单独记录的,所以没有 “ . github 中所有可能的文件”页面。随意放置任何与 Github相关的东西,特别是在它里面。

.github文件夹中一些最常用的文件:

  • CODE_OF_CONDUCT.md-> 如何参与社区活动以及如何规范自己的行为。
  • CONTRIBUTING.md-> 如何为回购协议作出贡献(提出拉动要求,设置开发环境..。)
  • LICENSE.md-软件许可证告诉其他人他们可以用你的源代码 (因为 GitHub 在 .github文件夹中忽略它,所以应该将它放在项目的根目录中。您可以在浏览其他 Git 托管服务(如 GitLab、 Bitbucket 等)时找到这个文件。)做什么和不能做什么
  • FUNDING.yml-> 支援计划
  • > 文件夹,包含用户可以用来打开问题的可能问题的模板(例如问题是否与文档有关,是否是 bug,用户是否需要新功能等等) P.S. 看看张量流 模板
  • PULL_REQUEST_TEMPLATE.md-> 如何向项目发出请求
  • stale.yml-> Probot 配置来关闭过期问题。在 GitHub Marketplace 上还有许多其他的应用程序,它们将自己的配置放在 .github文件夹中,因为它们专门与 GitHub 相关。
  • 如何负责任地报告项目中的安全漏洞
  • workflows-> Configuration 文件夹,其中包含 GitHub Actions 的 yaml 文件
  • 拉请求审查规则。更多信息。
  • 依赖更新的配置选项。更多信息。

您不必立即创建所有这些文件。如果在您的项目中报告了很多错误,那么创建 ISSUE_TEMPLATE。如果有几个人想要支持你,创建 FUNDING.yml。当需要时,您将创建越来越多的文件。

Github 列出了在标题为 创建默认的社区健康文件的文档页面中可以使用的所有文件,可以添加到 .github目录中的工作流在 GitHub 操作简介文档中有详细说明。