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

Popular posts from this blog

PySide and Qt Properties: Connecting signals from Python to QML -

i trying run simple pyside appliccation design made in qml. call function in qml python in separated thread. i have following qml view: import qt 4.7 rectangle { visible: true width: 100; height: 100 color: "lightgrey" text { id: datestr objectname: "datestr" x: 10 y: 10 text: "init text" font.pixelsize: 12 function updatedata(text) { datestr.text = qstr(text) console.log("you said: " + text) } } } here application: some imports.... #!/usr/bin/python import sys import time pyside import qtdeclarative, qtcore pyside.qtgui import qapplication pyside.qtdeclarative import qdeclarativeview the qthread worker.... #worker thread class worker(qtcore.qthread): updateprogress = qtcore.signal(int) def __init__(self, child): qtcore.qthread.__init__(self) self.child = child def run(self):
Read more

c# - DevExpress.Wpf.Grid.InfiniteGridSizeException was unhandled -

Image
when using devexpress, see error: devexpress.wpf.grid.infinitegridsizeexception unhandled message="by default, infinite grid height not allowed since grid rows rendered , hence grid work slowly. fix issue, should place grid container give finite height grid, or should manually specify grid's height or maxheight. note can avoid exception setting gridcontrol.allowinfinitegridsize static property true, in case grid run slowly." the problem dxgrid has infinite height. to fix, set height non-infinite. snoop absolutely invaluable this: if "height" xaml element infinite (i.e. 0 or nan ), can set using one of following: option 1: height="{binding path=actualheight, relativesource={relativesource mode=findancestor, ancestortype=uielement}}" option 2: verticalalignment="stretch" option 3: height="auto" hint: use verticalalignment="stretch" if child of grid <rowdefinition height=
Read more

scala - 'wrong top statement declaration' when using slick in IntelliJ -

Image
i'm porting project scala 2.9 2.10, therefore have use slick instead of scalaquery. i'm using slick 2.1.0 since supports ms access. according this tutorial , upgrade guide changed robs object class , added val robs : why error message wrong top statement declaration , how rid of it? edit: i'm new scala... according this question seems can't put val outside of methods or classes, right? code above directly in packge. right approach slick then? should move code in class or trait? according this changed val robs = tablequery[robs] to object robs extends tablequery(new robs(_)) {} . no warnings or errors anymore. :)
Read more