Gerador de citações do GitHub

Suas citações

Consulte um repositório ou digite o nome do software para ver suas citações.

Como usar o gerador de citações do GitHub

1. 1. Cole o endereço do repositório e clique em Consultar. Qualquer formato serve: https://github.com/owner/repository, um link para um arquivo dentro dele ou apenas owner/repository.
2. 2. Confira o que foi preenchido. A partir de um CITATION.cff você recebe os autores, o título, a versão, a data de lançamento e o DOI escolhidos pelos desenvolvedores. Sem ele, o GitHub só conhece o nome da conta e a versão mais recente — acrescente os autores reais se o projeto os indicar.
3. 3. Mantenha o DOI. Quando a versão é arquivada no Zenodo ou em outro repositório, o DOI é permanente, e todos os estilos o preferem ao endereço do GitHub.
4. 4. Copie suas citações. Se o CITATION.cff indicar um artigo para citar, as citações dele aparecem depois das do software — muitos projetos pedem as duas.

O que um arquivo CITATION.cff oferece

O CITATION.cff é um pequeno arquivo YAML na raiz de um repositório que indica como o software deve ser citado, no Citation File Format (versão 1.2.0). O GitHub o lê para mostrar o botão "Cite this repository" com APA e BibTeX, e esta ferramenta lê as mesmas chaves:

Como citar software em APA, MLA e Chicago

APA 7 (§10.10) cita software com a versão entre parênteses e a descrição [Computer software] depois do título, seguida da editora e de um DOI ou URL — a APA não tem exemplo para o GitHub, então o GitHub funciona como editora, a menos que a versão esteja arquivada em outro lugar. MLA 9 monta a entrada a partir de seus elementos centrais; o post do MLA Style Center sobre como citar código-fonte trata o dono do repositório como autor, mantém a capitalização do software exatamente como ela é, indica a versão e torna o GitHub um segundo contêiner antes do URL. Chicago 18 (§14.169) lista o software sob o seu desenvolvedor na bibliografia, com a versão e a editora. No BibTeX, o @misc clássico não tem campo de versão, então a versão vai em uma nota; o biblatex tem um tipo @software próprio.

Exemplos de citações do GitHub

A própria especificação do Citation File Format, cujo CITATION.cff lista nove autores, a versão 1.2.0, a data de lançamento de 9 de agosto de 2021 e um DOI do Zenodo:

@software{druskat2021citation,
  author    = {Druskat, Stephan and Spaaks, Jurriaan H. and Chue Hong, Neil and Haines, Robert and Baker, James and Bliven, Spencer and Willighagen, Egon and Pérez-Suárez, David and Konovalov, Olexandr},
  title     = {{Citation File Format}},
  version   = {1.2.0},
  date      = {2021-08-09},
  publisher = {Zenodo},
  doi       = {10.5281/zenodo.5171937},
  url       = {https://github.com/citation-file-format/citation-file-format}
}

O CITATION.cff do Matplotlib também pede que se cite o artigo de John D. Hunter de 2007. A ferramenta formata essa citação preferencial também:

@article{hunter2007matplotlib,
  author  = {Hunter, John D.},
  title   = {{Matplotlib: A 2D graphics environment}},
  journal = {Computing in Science \& Engineering},
  volume  = {9},
  number  = {3},
  pages   = {90--95},
  year    = {2007},
  doi     = {10.1109/MCSE.2007.55}
}

Quando um repositório não tem CITATION.cff

Sem um CITATION.cff, a ferramenta recorre aos detalhes públicos do repositório no GitHub: o nome do repositório como título, a conta do dono como autor e a tag e a data da versão mais recente, se houver. Isso é um ponto de partida, não uma citação pronta — procure os autores no README ou no site do projeto e cite a versão que você de fato usou. Sem login, o GitHub permite 60 requisições à API por hora a partir de uma mesma conexão, e uma consulta usa uma ou duas; se você atingir o limite, a ferramenta informa quando ele é renovado, e você pode preencher o formulário à mão. Se você mantém o repositório, adicionar um CITATION.cff deixa todas as citações dele consistentes — o Gerador de citações de software e código cobre programas que não estão no GitHub.

Erros comuns

• Citar o nome da conta como autor. "numpy" é uma conta; os autores são as pessoas ou a equipe que o projeto indica.
• Deixar de fora a versão. O código muda entre as versões. Informe a versão, a tag de lançamento ou o commit que você usou.
• Usar o endereço do GitHub quando há um DOI. O DOI de uma versão arquivada não se quebra quando um repositório muda de lugar.
• Ignorar a citação preferencial. Se os desenvolvedores pedirem que você cite o artigo deles, cite-o — normalmente junto com o software.
• "Corrigir" as maiúsculas do nome de um software. pandas, NumPy e scikit-learn são escritos do jeito que seus desenvolvedores os escrevem.

Perguntas frequentes

Como citar um repositório do GitHub em APA 7?

Cite-o como software: os autores, o ano da versão, o nome em itálico, a versão entre parênteses, [Computer software], a editora e o link. Sem arquivo, a editora é o GitHub e o link é o endereço do repositório; com um DOI do Zenodo, a editora é o Zenodo e o link é o DOI. No texto: (Druskat et al., 2021).

O que é um arquivo CITATION.cff?

É um arquivo YAML de texto simples na raiz de um repositório que indica como citar o software, no Citation File Format. Ele lista os autores, o título, a versão, a data de lançamento e o DOI, e pode indicar um artigo para citar no lugar. O GitHub o transforma no botão "Cite this repository".

Devo citar o software ou o artigo sobre ele?

Siga o que os desenvolvedores pedem no CITATION.cff. Muitos pedem o artigo, e o guia do Citation File Format observa que o software merece crédito como qualquer outro resultado de pesquisa; por isso, citar os dois é comum — o artigo pelo método, o software pela versão que você executou.

Como obter uma entrada BibTeX para um repositório do GitHub?

Consulte aqui e copie a entrada: @misc para o BibTeX clássico, com a versão em uma nota, ou @software para o biblatex. Ambos mantêm o nome do software entre chaves duplas para que suas maiúsculas sobrevivam.

A consulta precisa de uma conta no GitHub?

Não. Ela usa a API pública do GitHub e lê o arquivo CITATION.cff de raw.githubusercontent.com, diretamente do seu navegador, enviando apenas o endereço do repositório. Sem login, o GitHub permite 60 requisições à API por hora por conexão, e uma consulta usa uma ou duas.

E se o repositório for privado ou estiver no GitLab?

A consulta só lê repositórios públicos do GitHub. Para qualquer outro caso, digite os dados no formulário — as citações são formatadas do mesmo jeito — ou use o Gerador de citações de software e código.