The GitHub citation feature will also detect a small number of additional files that are often used by communities and projects to describe how they would like their work to be cited. If your repository contains a dataset, you can set type: dataset at the top level of your CITATION.cff file to produce a data citation string output in the GitHub citation prompt. The example CITATION.cff file above will produce the following outputs in the GitHub citation prompt:ĪPA Lisa, M., & Bot, H.

Report/technical CITATION.cff file describing the software, but linking to a research article as the preferred citation: cff-version: 1.2.0 Magazine any other CFF software-code, software-container, software-executable, software] If you would prefer the GitHub citation information to link to another resource such as a research article, then you can use the preferred-citation override in CFF with the following types.

This makes it easy for other users to cite your software project, using the information you've provided. When you add a CITATION.cff file to the default branch of your repository, it is automatically linked from the repository landing page. Note the example above produces a software citation (i.e., type in BibTeX rather than more information, see the Citation File Format website. The GitHub citation prompt on your repository will show the example CITATION.cff content in these formats:ĪPA Lisa, M., & Bot, H. Message: 'If you use this software, please cite it as below.' The citation file format is plain text with human- and machine-readable citation information.Įxample CITATION.cff file: cff-version: 1.2.0 You can add a CITATION.cff file to the root of a repository to let others know how you would like them to cite your work.

Citation boris video software