Sobre os arquivos de CITATION

Você pode adicionar um arquivo de CITATION ao seu repositório para ajudar os usuários a citar corretamente o seu software.

Sobre os arquivos de CITATION

Você pode adicionar um arquivo de CITATION.cff à raiz de um repositório para que outros saibam como você gostaria que eles citassem 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 de 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"

A instrução da citação no GitHub no seu repositório irá mostrar o exemplo CITATION.cff nesses 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},
  version = {2.0.4},
  year = {2017}
}

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

Para obter mais informações, consulte o site do Formato do Arquivo de Citação.

Ao adicionar um arquivo CITATION.cff ao branch padrão do repositório, ele será automaticamente vinculado a partir da página inicial do repositório. Isso torna fácil para outros usuários citar seu projeto de software, usando as informações que você forneceu.

Link de citação na página inicial do repositório

Citando algo diferente de software

Se você prefere que as informações de citação de GitHub vinculem outro recurso, como um artigo de pesquisa, você poderá usar a substituição de preferred-citation no CFF pelos seguintes tipos.

RecursoTipo
Artigo de pesquisaartigo
Documento de conferênciaconference-paper
Livrolivro

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"
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 do arquivo CITATION.cff acima produzirá as saídas a seguir na instrução da citação no GitHub:

APA

Lisa, M., & Bot, H. (2021). Meu software de pesquisa incrível. 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 seu repositório contiver um conjunto de dados, você poderá definir o type: dataset no seu arquivo de CITATION.cff para produzir uma saída de string de citação de dados na instrução da citação de 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 irá vincular a esses arquivos na instrução 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 oferecemos suporte a formatos de arquivo APA e BibTex.

Você está buscando formatos de citação adicionais? O GitHub usa uma biblioteca do Ruby para analisar os arquivos CITATION.cff. Você pode solicitar formatos adicionais no repositório ruby-cff ou você mesmo pode fazer uma contribuição.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.