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

Question

我一直在寻找可以进入.githubGitHub 存储库目录的零碎示例。

我可以看到它用于 GitHub 操作和工作流以及拉取请求和问题模板，但我看不到一个页面，其中概述了您可以在理想情况下放入一些文档的内容。我也认为我已经看到了一个资助的例子。

基本上每次我看到你可以在那里做的事情时，我都认为“我应该这样做很好”，但除了示例之外，我看不到除示例之外发现新事物的方法。

由于该目录被称为这一事实，.github它似乎也无视 Google 和 SO 搜索。

Answer 1

在 Github 上，folder.github只是一个约定文件夹，用来放置 Github 相关的东西。Github 会处理其中一些文件，即使您将其放置在项目的根目录中（例如CONTRIBUTING.md,CODE_OF_CONDUCT.md等）。因为 Github 不断引入新功能，这些功能都是自己记录的，所以没有“.github 中所有可能的文件”页面。随意将与Github相关的任何内容放在其中。

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

• CODE_OF_CONDUCT.md -> 如何参与社区以及如何表现自己。
• CONTRIBUTING.md-> 如何为 repo 做出贡献（提出请求请求，设置开发环境......）
• LICENSE.md- 软件许可证告诉其他人他们可以用你的源代码做什么和不能做什么（你应该把它放在你的项目的根目录，因为 GitHub 在.github文件夹中忽略它。你可以在浏览其他 Git 托管服务时找到这个文件，比如 GitLab 、Bitbucket 等）
• FUNDING.yml -> 支持一个项目
• ISSUE_TEMPLATE-> 包含用户可以用来打开问题的可能问题模板的文件夹（例如问题是否与文档相关，是否是错误，如果用户想要新功能等） PS 看看 tensorflow ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE.md -> 如何向项目发出拉取请求
• stale.yml-> Probot 配置以关闭陈旧的问题。Github Marketplace 上还有许多其他应用程序将它们的配置放在.github文件夹中，因为它们特别与 GitHub 相关。
• SECURITY.md -> 如何负责任地报告项目中的安全漏洞
• workflows -> 包含 GitHub 操作的 yaml 文件的配置文件夹
• CODEOWNERS-> 拉取请求审阅者规则。更多信息在这里。

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

Answer 2

Github 列出了您可以在标题为创建默认社区健康文件的文档页面中使用的所有文件，并且您可以添加到该目录的工作流程在GitHub Actions 简介.github文档中详细介绍。