Ferramentas de Pesquisa 3 min de leitura

Suporte para citações de repositórios do GitHub

Por Jalves Nicacio
The image shows the GitHub mascot, Octocat, a cat-octopus hybrid.

Aprenda como disponibilizar arquivos de citação estilo APA ou bibtex em seus repositórios

Como você torna mais fácil para outras pessoas citarem seu trabalho?
Em trabalhos acadêmicos, muitas vezes desenvolvemos protótipos ou disponibilizamos visualizações de dados por meio de repositórios. Uma forma de disponibilizarmos esses artefatos de pesquisa é por meio da plataforma GitHub, que nos permite não apenas disponibilizar publicamente softwares, protótipos ou dados, mas também controlar seu versionamento.

No entanto, quando escrevemos um artigo e queremos fazer referência a um repositório GitHub, pode ser um pouco difícil saber a melhor forma de fazer referência a esses repositórios. Com isso em mente, o Github criou recentemente uma forma de oferecer suporte oficial a citações ao repositório de dados ou código. Este novo recurso, desenvolvido pelo GitHub, permite que pesquisadores e acadêmicos informem a comunidade e interessados ​​sobre como citar adequadamente seus repositórios, principalmente em artigos científicos.

Para isso, os pesquisadores devem adicionar um novo arquivo ao seu repositório: CITATION.cff. De acordo com Arfon Smith, membro da equipe do Github, as informações neste arquivo são usadas para criar links de citação convenientes no estilo APA ou BibTeX que podem ser referenciados por outras pessoas.

Para habilitar esse recurso em seu repositório, você pode simplesmente criar um arquivo chamado CITATION.cff em seu repositório. Use o exemplo abaixo como modelo para seu arquivo:

cff-version: 1.2.0
message: “If you use this software, please cite it as below.”
authors:
– family-names: Druskat
given-names: Stephan
orcid: https://orcid.org/0000-0003-4925-7248
title: “My Research Software”
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2021-08-11

Você também pode usar o website cffinit Para preencher as informações do seu arquivo de citação. Você pode obter mais informações sobre o formato de arquivo cff nesta página: O que é um arquivo de citação CITATION.cff ?