是否概述了可以放入.github"dot github"文档中的内容?目录? [英] Is there an overview of what can go into a .github "dot github" directory?

问题描述

我一直在寻找零散的示例，这些示例可以放入GitHub存储库中的 .github 目录中.

I keep finding piecemeal examples of things that can go into a .github directory on a GitHub repository.

我可以看到它用于GitHub动作和工作流以及Pull请求和问题模板，但是我看不到一个页面，该页面概述了可以在其中放置一些理想文档的内容.我还认为我也看到了一个资助示例.

I can see that it is used for GitHub actions and workflow and for Pull request and issue templates, but I can't see a page outlining what you can put in there with ideally some documentation. I also think I've seen a funding example too.

基本上，每次我看到您可以在其中做的事情时，我都认为那很干净，我应该这样做"，但是除了示例之外，除了示例之外，我看不到其他发现新事物的方法.

Basically every time I see something you can do there, I think "that's neat I should do that", but other than examples I can't see a way to discover new things other than by example.

由于该目录名为 .github ，因此它似乎也无视Google和SO搜索.

Due to the fact that the directory is called .github it seems to defy Google and SO search as well.

推荐答案

在Github上，文件夹 .github 只是一个约定俗成的文件夹，用于在其中放置与Github相关的内容.即使您将文件放置在项目的根目录中(例如，例如 CONTRIBUTING.md ， CODE_OF_CONDUCT.md 等)，Github也会处理其中一些文件.由于Github不断引入新功能，因此这些功能是单独记录的，因此没有.github中的所有可能文件" 页.随时将与 Github 相关的任何内容专门放置在其中.

On Github, folder .github is just a convention folder used to place Github related stuff inside it. Github handles some of these files even when you place it in root of your project (such as CONTRIBUTING.md, CODE_OF_CONDUCT.md etc). Because Github is constantly bringing in new features, these features are documented on their own, so there is no "all possible files in .github" page. Feel free to place anything that is related to Github specifically inside it.

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

Some of the most used files in .github folder:

• CODE_OF_CONDUCT.md ->如何参与社区活动以及如何表现自己.
• CONTRIBUTING.md ->如何为回购做贡献(提出请求，设置开发环境... )
• LICENSE.md -软件许可证告诉他人他们可以使用或不使用您的源代码(您应将其放置在您的项目，因为GitHub在 .github 文件夹中忽略了它.您可以在浏览其他Git托管服务(例如GitLab，Bitbucket等)时找到此文件.)
• FUNDING.yml ->支持项目
• ISSUE_TEMPLATE ->包含可能存在问题的模板的文件夹，用户可以使用该文件夹来打开问题(例如，是否与文档相关，是否为bug，是否需要新功能等).看看tensorflow ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE.md ->如何向项目发出拉动请求
• stale.yml ->Probot配置可解决过时的问题.Github Marketplace上还有许多其他应用程序将其配置放置在 .github 文件夹中，因为它们与GitHub特别相关.
• SECURITY.md ->如何负责任地报告项目中的安全漏洞
• 工作流程->包含GitHub Actions的yaml文件的配置文件夹
• CODEOWNERS ->拉取请求审阅者规则.更多信息此处.

• CODE_OF_CONDUCT.md -> How to engage in community and how to behave yourself.
• CONTRIBUTING.md -> How to contribute to repo (making pull request, setting development environment...)
• LICENSE.md - A software license tells others what they can and can't do with your source code (You should place this at the root of your project since GitHub ignores it in .github folder. You can find this file while browsing other Git hosting services such as GitLab, Bitbucket etc.)
• FUNDING.yml -> Supporting a project
• ISSUE_TEMPLATE -> Folder that contains a templates of possible issues user can use to open issue (such as if issue is related to documentation, if it's a bug, if user wants new feature etc) P.S. Take a look at tensorflow ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE.md -> How to make a pull request to project
• stale.yml -> Probot configuration to close stale issues. There are many other apps on Github Marketplace that place their configurations inside .github folder because they are related to GitHub specifically.
• SECURITY.md -> How to responsibly report a security vulnerability in project
• workflows -> Configuration folder containing yaml files for GitHub Actions
• CODEOWNERS -> Pull request reviewer rules. More info here.

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

You don't have to create all these files immediately. If there are lot of bugs reported in your project, create ISSUE_TEMPLATE. If several people wants to support you, create FUNDING.yml . You will create more and more files when the need comes.

这篇关于是否概述了可以放入.github"dot github"文档中的内容?目录?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！