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

标签 github

我一直在寻找可以进入 .github 的事物的零碎示例。 GitHub 存储库上的目录。
我可以看到它用于 GitHub 操作和工作流以及拉取请求和问题模板,但我看不到一个页面,其中概述了您可以在理想情况下放入一些文档的内容。我也认为我已经看到了一个资助的例子。
基本上每次我看到你可以在那里做的事情时,我都认为“我应该这样做很好”,但除了示例之外,我看不到除示例之外发现新事物的方法。
由于目录名为 .github它似乎也无视 Google 和 SO 搜索。

最佳答案

在 Github 上,文件夹 .github只是一个约定文件夹,用于在其中放置 Github 相关内容。 Github 会处理其中一些文件,即使您将其放在项目的根目录中(例如 CONTRIBUTING.mdCODE_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 -> 包含用户可以用来打开问题的可能问题模板的文件夹(例如问题是否与文档有关,是否是错误,如果用户想要新功能等)看看tensorflow ISSUE_TEMPLATE
  • PULL_REQUEST_TEMPLATE.md -> 如何向项目发出拉取请求
  • stale.yml -> Probot 配置以关闭陈旧的问题。 Github Marketplace 上还有许多其他应用程序将它们的配置放在.github 中。文件夹,因为它们特别与 GitHub 相关。
  • SECURITY.md -> 如何负责任地报告项目中的安全漏洞
  • workflows -> 包含 GitHub 操作的 yaml 文件的配置文件夹
  • CODEOWNERS -> 拉取请求审阅者规则。更多信息 here .

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

    关于github - 有什么可以进入 .github "dot github"目录的概述吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/60507097/

    相关文章:

    rest - 在 Delphi 中使用来自 Indy 的 GitHub API

    github - 在 Github Action 中通过 Yarn 从 Github 包注册表下载私有(private)模块?发布工作,但安装遇到 '401 Unauthorized'

    git - 看不到未跟踪的文件

    github - 如何在不使用release分支的情况下使用git flow?

    git - 从 bash 更新 github 上的文件

    git - 对于 GitHub 提交,我以两位合著者的身份出现

    git - 像 GitHub 垃圾这样的 Web 界面是否会收集悬挂的远程 git 提交,如果没有,是否有可能获取它们?

    api - 通过其 API 更新要点

    git - 我的 git rebase 工作流程做错了什么?

    ios - Xcode、GitHub 和第三方框架