有没有关于.github的概述;dot github“;目录
我一直在寻找可以进入github存储库的有没有关于.github的概述;dot github“;目录,github,Github,我一直在寻找可以进入github存储库的.github目录的零碎示例 我可以看到它被用于GitHub操作和工作流,以及请求和问题模板,但我看不到一个页面概括了您可以在其中添加哪些文档。我也看到了一个融资的例子 基本上,每次我看到你能做的事情,我都会想“我应该做得很好”,但除了例子之外,除了通过例子,我看不到发现新事物的方法 由于该目录名为.github,它似乎与谷歌不符,因此搜索也不例外。在github上,文件夹。github只是一个常规文件夹,用于在其中放置与github相关的内容。Githu
.github
目录的零碎示例
我可以看到它被用于GitHub操作和工作流,以及请求和问题模板,但我看不到一个页面概括了您可以在其中添加哪些文档。我也看到了一个融资的例子
基本上,每次我看到你能做的事情,我都会想“我应该做得很好”,但除了例子之外,除了通过例子,我看不到发现新事物的方法
由于该目录名为
.github
,它似乎与谷歌不符,因此搜索也不例外。在github上,文件夹。github
只是一个常规文件夹,用于在其中放置与github相关的内容。Github即使将其中一些文件放在项目的根目录中也能处理(例如contribution.md
,code\u of_CONDUCT.md
等)。由于Github不断引入新功能,这些功能都是单独记录的,因此没有“所有可能的文件都在.Github”页面。您可以随意将任何与Github相关的内容放入其中
.github
文件夹中一些最常用的文件:
->如何参与社区活动以及如何表现自己行为准则.md
->如何为回购做出贡献(发出请求、设置开发环境…)contribution.md
-软件许可告诉其他人他们可以和不能使用您的源代码做什么(您应该将其放在项目的根目录下,因为GitHub会在LICENSE.md
文件夹中忽略它。您可以在浏览GitLab、Bitbucket等其他Git托管服务时找到此文件。).GitHub
->支持项目FUNDING.yml
->文件夹,其中包含用户可以用来打开问题的可能问题的模板(例如,问题是否与文档相关、是否存在缺陷、用户是否需要新功能等)。请查看tensorflowISSUE\u TEMPLATE
->如何向project发出请求PULL\u REQUEST\u TEMPLATE.md
->用于关闭过时问题的Probot配置。Github Marketplace上还有许多其他应用程序将其配置放在stale.yml
文件夹中,因为它们专门与Github相关.Github
->如何负责地报告项目中的安全漏洞SECURITY.md
->包含GitHub操作的yaml文件的配置文件夹工作流
->提取请求审阅者规则。更多信息CODEOWNERS
您不必立即创建所有这些文件。如果在您的项目中报告了很多错误,请创建
问题\u模板
。如果有几个人想支持你,请创建FUNDING.yml
。当需要时,您将创建越来越多的文件。Github列出了标题为“文档”页面中可以使用的所有文件以及可以添加到目录中的工作流。Github
目录在文档中有详细说明。可能不完整,但似乎是一个很好的开始列表。是的,这对社区repo很有好处,但是错过了行动,谁知道还有什么。@JeremyFrench我的回答是否为你的问题提供了足够的信息?如果是这样,你可以接受它作为well@DinkoPehar我已经这样做了,将其标记为CW可能会更好(如果仍然可能的话)因此,如果有新的内容,其他人可以在将来进行更新。GitHub似乎忽略了.GitHub中的许可证文件-似乎只关注项目根目录中的许可证文件。您还可以创建settings.yml文件,其中可以设置存储库的设置。CodeOwners是另一个我会添加到列表中的文件。您现在可以编辑并添加它。我将其标记为community wikiAlways,将许可证文件放在项目的根目录中,而不是.github/
文件夹中。