git - 什么是CHANGELOG / LICENSE / VERSION / CONTRIBUTING / new_issue等特殊文件？

GitHub.com和GitLab等热门存储库托管平台支持使用特殊文件（自述文件），如README / CHANGELOG / LICENSE / VERSION / CONTRIBUTING（或类似的，例如以.md结尾）并提供与它们的直接链接或根据其含义将它们包含在项目网站中。

如果我想搜索一般的可用文件（不是一个项目/回购）我应该搜索什么？ 这些文件名称是什么？

至少Changelog counts as Readme according to wikipedia。所以可以称之为自述文件。但是还有其他文件，例如问题/拉取请求模板（例如GitHub的ISSUE_TEMPLATE）或类似的（取决于平台）。

如果没有普遍的约定，我们可以开始讨论（https://github.com/kmindi/special-files-in-repository-root/issues/1）

此问题不适用于列出可用的特殊文件或其各自的文件命名约定。有关Changelog的命名约定，请参阅示例keepachangelog.com。它也不仅限于git存储库，而是高度相关，因为这是我期望的流行用途。

有什么特殊文件，例如CHANGELOG / LICENSE / VERSION / CONTRIBUTING / new_issue？

它们没有被称为任何特殊的东西（有＃34;元数据＆＃34;您的项目的各种类型）。
它们由存储库托管服务器（如GitHub或GitLab）以某种方式解释，但这完全取决于托管服务器以突出显示某些文件。
但是从这些服务管理的存储库的角度来看，它们只是文件。

即使他们的命名惯例也没有完全修复。例如，请参阅issue 14611

当我点击添加贡献指南时，我得到一个页面来创建一个名为CONTRIBUTING.md的文件，但是当我去添加许可证或更改日志时，我得到的文件没有.md扩展名。
    我认为这是一个错误，因为它们都应该具有一致的行为并且具有.md扩展名。


文件名基于在开源存储库中观察到的使用情况，其中LICENSE和CHANGELOG是相对简单的文件，CONTRIBUTING.md是一个更复杂的文档。

什么是CHANGELOG / LICENSE / VERSION / CONTRIBUTING / new_issue等特殊文件？

1 个答案: