kmi*_*ndi 6 git naming github repository gitlab
流行的存储库托管平台(例如 GitHub.com 和 GitLab)允许使用特殊文件(自述文件),例如README/ CHANGELOG/ LICENSE/ VERSION/ CONTRIBUTING(或类似的,例如以 结尾.md),并提供指向它们的直接链接或根据它们的用途将它们包含在项目网站中意义。
如果我想搜索一般可用文件(不是一个项目/存储库),我应该搜索什么?这些文件叫什么?
根据维基百科,至少Changelog 算作自述文件。因此,人们可以将它们称为自述文件。但还有其他文件,例如问题/拉取请求模板(例如ISSUE_TEMPLATEGitHub)或类似文件(取决于平台)。
如果没有普遍的约定,我们可以开始讨论(https://github.com/kmindi/special-files-in-repository-root/issues/1)
这个问题不是为了列出可用的特殊文件或其各自的文件命名约定。有关 Changelog 的命名约定,请参阅keepachangelog.com等。它也不限于 git 存储库,而是高度相关,因为这是我期望的流行用途。
CHANGELOG/LICENSE/VERSION/CONTRIBUTING/new_issue 等特殊文件被称为什么?
它们没有任何特殊的名称(您的项目有某种“元数据”)。
它们由存储库托管服务器(如 GitHub 或 GitLab)以某种方式解释,但这完全取决于托管服务器来突出显示某些文件。
但从这些服务管理的存储库的角度来看,它们只是文件。
甚至他们的命名约定也没有完全固定。例如,请参见问题 14611
当我单击“添加贡献指南”时,我会看到一个页面来创建一个名为的文件
CONTRIBUTING.md,但是当我去添加许可证或更改日志时,我会得到没有.md扩展名的文件。
我认为这是一个错误,因为它们都应该具有一致的行为并具有.md扩展名。文件名基于在开源存储库中观察到的使用情况,其中
LICENSE和CHANGELOG是相对简单的文件,并且CONTRIBUTING.md是更复杂的文档。
| 归档时间: |
|
| 查看次数: |
1059 次 |
| 最近记录: |