Sobre os arquivos de CITATION

Você pode adicionar um arquivo CITATION.cff à raiz de um repositório para que outras pessoas saibam como você deseja que elas citem seu trabalho. O formato do arquivo de citação é um texto simples com informações de citação legíveis por pessoas e máquinas.

Exemplo de arquivo CITATION.cff:

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"

O prompt de citação do GitHub em seu repositório mostrará o conteúdo de exemplo do CITATION.cff nestes formatos:

APA

Lisa, M., & Bot, H. (2017). My Research Software (Version 2.0.4) [Computer software]. https://doi.org/10.5281/zenodo.1234

BibTeX

@software{Lisa_My_Research_Software_2017,
  author = {Lisa, Mona and Bot, Hew},
  doi = {10.5281/zenodo.1234},
  month = {12},
  title = {{My Research Software}},
  url = {https://github.com/github-linguist/linguist},
  version = {2.0.4},
  year = {2017}
}

Observe que o exemplo acima produz uma citação de software (ou seja, tipo @software no BibTeX em vez de @article).

Para obter mais informações, confira o site Citation File Format.

Quando você adiciona um arquivo CITATION.cff ao branch padrão do repositório, um link é adicionado automaticamente à página de aterrissagem do repositório na barra lateral direita, com o rótulo "Citar este repositório". Isso torna fácil para outros usuários citar seu projeto de software, usando as informações que você forneceu.

Captura de tela que mostra a página de aterrissagem de um repositório. O link "Citar este repositório" na barra lateral direita está realçado com um contorno laranja escuro, e um menu suspenso com os detalhes da citação está expandido abaixo.

Citando algo diferente de software

Se preferir que as informações de citação do GitHub sejam vinculadas a outro recurso, como um artigo de pesquisa, use a substituição preferred-citation no CFF com os tipos a seguir.

Recurso	Tipo CFF	Tipo BibTeX	Anotações da APA
Artigo de jornal/documento	`article`	`@article`	Não aplicável
Livro	`book`	`@book`	Não aplicável
Folheto (vinculado mas não publicado)	`pamphlet`	`@booklet`	Não aplicável
Artigo de conferência/documento	`conference-paper`	`@inproceedings`	[Documento de conferência]
Atas de conferência	`conference`, `proceedings`	`@proceedings`	Não aplicável
Conjunto de dados	`data`, `database`	`@misc`	[Conjunto de dados]
Artigo de revista	`magazine-article`	`@article`	Não aplicável
Manual	`manual`	`@manual`	Não aplicável
Outros	`generic`, qualquer outro tipo CFF	`@misc`	Não aplicável
Artigo de jornal	`newspaper-article`	`@article`	Não aplicável
Software	`software`, `software-code`, `software-container`, `software-executable`, `software-virtual-machine`	`@software`	[Software de computador]
Relatório/relatório técnico	`report`	`@techreport`	Não aplicável
Não publicado	`unpublished`	`@unpublished`	Não aplicável

Arquivo de CITATION.cff estendido que descreve o software, mas vinculando a um artigo de pesquisa como a citação preferida:

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"
preferred-citation:
  type: article
  authors:
  - family-names: "Lisa"
    given-names: "Mona"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  - family-names: "Bot"
    given-names: "Hew"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  doi: "10.0000/00000"
  journal: "Journal Title"
  month: 9
  start: 1 # First page number
  end: 10 # Last page number
  title: "My awesome research software"
  issue: 1
  volume: 1
  year: 2021

O exemplo de arquivo CITATION.cff acima produzirá as seguintes saídas no prompt de citação do GitHub:

APA

Lisa, M., & Bot, H. (2021). My awesome research software. Journal Title, 1(1), 1. https://doi.org/10.0000/00000

BibTeX

@article{Lisa_My_awesome_research_2021,
  author = {Lisa, Mona and Bot, Hew},
  doi = {10.0000/00000},
  journal = {Journal Title},
  month = {9},
  number = {1},
  pages = {1--10},
  title = {{My awesome research software}},
  volume = {1},
  year = {2021}
}

Citando um conjunto de dados

Se o repositório contiver um conjunto de dados, você poderá definir type: dataset no nível superior do arquivo CITATION.cff para produzir uma saída de cadeia de caracteres de citação de dados no prompt de citação do GitHub.

Outros arquivos de citação

O recurso de citação no GitHub também detecta um pequeno número de arquivos adicionais que são frequentemente usados pelas comunidades e projetos para descrever como gostariam que seu trabalho fosse citado.

O GitHub criará um link para esses arquivos no prompt Citar este repositório, mas não tentará analisá-los em outros formatos de citação.

# Note these are case-insensitive and must be in the root of the repository
CITATION
CITATIONS
CITATION.bib
CITATIONS.bib
CITATION.md
CITATIONS.md

# CITATION files for R packages are typically found at inst/CITATION
inst/CITATION

Formatos de citação

Atualmente, aceitamos os formatos de arquivo APA e BibTex.

Você está buscando formatos de citação adicionais? O GitHub usa uma biblioteca Ruby para analisar os arquivos CITATION.cff. Você pode solicitar formatos adicionais no repositório ruby-cff ou contribuir com eles por conta própria.

Sobre os arquivos de CITATION

Neste artigo