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

Question

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

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

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

由于目录被调用的事实，.github它似乎也无视谷歌和 SO 搜索。

标签： github

Answer 1

在 Github 上，文件夹.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）时找到此文件, 比特桶等)
• FUNDING.yml-> 支持一个项目
• ISSUE_TEMPLATE-> 包含用户可以用来打开问题的可能问题模板的文件夹（例如问题是否与文档有关，如果它是错误，如果用户想要新功能等） PS 看看 tensorflow ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE.md-> 如何向项目提出拉取请求
• stale.yml-> Probot 配置以关闭陈旧的问题。Github Marketplace 上还有许多其他应用程序将其配置放在.github文件夹中，因为它们专门与 GitHub 相关。
• SECURITY.md-> 如何负责任地报告项目中的安全漏洞
• workflows-> 包含 GitHub Actions 的 yaml 文件的配置文件夹
• CODEOWNERS-> 拉取请求审阅者规则。更多信息在这里。
• dependabot.yml-> 依赖项更新的配置选项。更多信息在这里。

---

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