git - What are special files like CHANGELOG/LICENSE/VERSION/CONTRIBUTING/new_issue called? -
popular repository-hosting platforms github.com , gitlab enable use of special files (readme-files) readme
/changelog
/license
/version
/contributing
(or similar eg ending in .md
) , offer direct links them or include them in project website according meaning.
if want search available files in general (not 1 project/repo) should search for? what these files called?
at least changelog counts readme according wikipedia. 1 call them readme-files. there additional files issue/pull request templates (eg issue_template
github) or similar (depending on platform).
if there no prevalent convention can start discussion (https://github.com/kmindi/special-files-in-repository-root/issues/1)
this question not listing available special files or respective file naming convention. naming conventions of changelog see example keepachangelog.com. not restricted git repositories, highly related because thats expect popular uses.
what special files changelog/license/version/contributing/new_issue called?
they not called special (there "metadata" of sorts project).
interpreted repository hosting server (like github or gitlab) way, entirely hosting server highlight files.
point of view of repository managed services, files.
even naming convention isn't fixed. see instance issue 14611
when click add contribution guide page create file named
contributing.md
when go add license or changelog files without.md
extension.
think bug, of them should have consistent behavior , have.md
extension.the filenames based on observed use in open source repositories,
license
,changelog
relatively simple files, ,contributing.md
more complex document.
Comments
Post a Comment