Artigos têm páginas de rosto; o software de pesquisa muitas vezes não tinha. Os usuários podiam ver o código, mas não a lista exata de autores, a versão, o DOI ou a citação preferida, de modo que o software era citado de forma inconsistente ou não era citado.

O Citation File Format resolveu isso com quase nenhuma infraestrutura. Um mantenedor adiciona `CITATION.cff`, um arquivo YAML em texto simples, à raiz do repositório. O arquivo informa a pessoas e máquinas exatamente como citar o software ou o conjunto de dados.

A alavanca de adoção foi o suporte das plataformas. O GitHub lê o CFF e expõe um aviso "Cite this repository" com saída em APA e BibTeX; Zenodo e Zotero podem reutilizar os mesmos metadados em vez de pedir aos autores que os insiram novamente.

Colocar metadados de citação ao lado do código

O nome do arquivo é convencional e descobrível na raiz do repositório.

O YAML manteve o arquivo legível por humanos e ainda assim estruturado o suficiente para validação e conversão.

A renderização pelas plataformas transformou uma convenção de mantenedor em um fluxo de trabalho para o usuário final.

As citações preferidas permitem que o software aponte para um artigo ou conjunto de dados sem perder os metadados do software.

Quando a atribuição é o problema, o melhor padrão pode ser um arquivo minúsculo no ponto onde os usuários já procuram o projeto.

O CFF tornou-se uma ponte prática entre a hospedagem de código e a citação acadêmica. O GitHub documenta suporte direto a arquivos CITATION.cff e os renderiza em APA e BibTeX, enquanto o projeto CFF aponta para o suporte de GitHub, Zenodo e Zotero.

CONFIRA AS EVIDÊNCIAS

As fontes

  1. Citation File Format (CFF) - Specifications Zenodo · zenodo.org ·
  2. About CITATION files GitHub Docs · docs.github.com