Générateur de citations GitHub

Vos citations

Recherchez un dépôt, ou saisissez le nom du logiciel, pour voir vos citations.

Comment utiliser le générateur de citations GitHub

1. 1. Collez l'adresse du dépôt et appuyez sur Rechercher. Toutes les formes conviennent : https://github.com/owner/repository, un lien vers un fichier qu'il contient, ou simplement owner/repository.
2. 2. Vérifiez ce qui a été rempli. À partir d'un CITATION.cff, vous obtenez les auteurs, le titre, la version, la date de publication et le DOI choisis par les développeurs. Sans ce fichier, GitHub ne connaît que le nom du compte et la dernière version publiée : ajoutez les vrais auteurs si le projet les indique.
3. 3. Conservez le DOI. Lorsque la version est archivée sur Zenodo ou dans un autre dépôt, son DOI est permanent, et tous les styles le préfèrent à l'adresse GitHub.
4. 4. Copiez vos citations. Si le CITATION.cff désigne un article à citer, ses citations apparaissent après celles du logiciel : beaucoup de projets demandent les deux.

Ce que vous apporte un fichier CITATION.cff

CITATION.cff est un petit fichier YAML placé à la racine d'un dépôt, qui indique comment citer le logiciel, selon le Citation File Format (version 1.2.0). GitHub le lit pour afficher un bouton « Cite this repository » avec APA et BibTeX, et cet outil lit les mêmes clés :

Citer un logiciel en APA, MLA et Chicago

Le style APA 7 (§10.10) cite les logiciels avec leur version entre parenthèses et la description [Computer software] après le titre, puis l'éditeur et un DOI ou une URL. APA n'a pas d'exemple pour GitHub : GitHub fait donc office d'éditeur, sauf si la version est archivée ailleurs. Le style MLA 9 construit l'entrée à partir de ses éléments principaux ; le MLA Style Center, dans son billet sur la citation de code source, considère que le propriétaire du dépôt est l'auteur, conserve exactement la casse du nom du logiciel, indique la version et fait de GitHub un second conteneur avant l'URL. Le style Chicago 18 (§14.169) classe les logiciels sous leur développeur dans la bibliographie, avec la version et l'éditeur. En BibTeX, le @misc classique n'a pas de champ de version, donc la version va dans une note ; biblatex dispose d'un vrai type @software.

Exemples de citations GitHub

La spécification Citation File Format elle-même, dont le CITATION.cff liste neuf auteurs, la version 1.2.0, une date de publication du 9 août 2021 et un DOI 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}
}

Le CITATION.cff de Matplotlib demande aussi de citer l'article de John D. Hunter publié en 2007. L'outil met également en forme cette citation préférée :

@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}
}

Lorsqu'un dépôt n'a pas de CITATION.cff

Sans CITATION.cff, l'outil s'appuie sur les informations publiques de GitHub sur le dépôt : le nom du dépôt comme titre, le compte du propriétaire comme auteur, et l'étiquette et la date de la dernière version, s'il en existe une. C'est un point de départ, non une citation achevée : cherchez les auteurs dans le README ou sur le site du projet, et citez la version que vous avez réellement utilisée. Sans connexion, GitHub autorise 60 requêtes API par heure depuis une même connexion, et une recherche en utilise une ou deux ; si vous atteignez la limite, l'outil indique quand elle se réinitialise, et vous pouvez remplir le formulaire à la main. Si vous maintenez le dépôt, ajouter un CITATION.cff rend toutes les citations de celui-ci cohérentes. Le Générateur de citations de logiciels et de code couvre les programmes qui ne sont pas sur GitHub.

Erreurs courantes

• Citer le nom du compte comme auteur. « numpy » est un compte ; les auteurs sont les personnes ou l'équipe que le projet désigne.
• Oublier la version. Le code change d'une version à l'autre. Indiquez la version, l'étiquette de publication ou le commit que vous avez utilisé.
• Utiliser l'adresse GitHub alors qu'il existe un DOI. Le DOI d'une version archivée ne casse pas lorsque le dépôt change d'adresse.
• Ignorer la citation préférée. Si les développeurs demandent de citer leur article, citez-le, généralement avec le logiciel.
• « Corriger » les majuscules d'un nom de logiciel. pandas, NumPy et scikit-learn s'écrivent comme leurs développeurs les écrivent.

Questions fréquentes

Comment citer un dépôt GitHub en APA 7 ?

Citez-le comme un logiciel : les auteurs, l'année de la version, le nom en italique, la version entre parenthèses, [Computer software], l'éditeur et le lien. Sans archive, l'éditeur est GitHub et le lien est l'URL du dépôt ; avec un DOI Zenodo, l'éditeur est Zenodo et le lien est le DOI. Dans le texte : (Druskat et al., 2021).

Qu'est-ce qu'un fichier CITATION.cff ?

Un fichier texte au format YAML, placé à la racine d'un dépôt, qui indique comment citer le logiciel selon le Citation File Format. Il liste les auteurs, le titre, la version, la date de publication et le DOI, et peut désigner un article à citer à la place. GitHub le transforme en bouton « Cite this repository ».

Faut-il citer le logiciel ou l'article qui le décrit ?

Suivez les souhaits des développeurs indiqués dans le CITATION.cff. Beaucoup demandent l'article, et le guide du Citation File Format rappelle que les logiciels méritent d'être crédités comme tout autre résultat de recherche : il est donc courant de citer les deux, l'article pour la méthode et le logiciel pour la version que vous avez utilisée.

Comment obtenir une entrée BibTeX pour un dépôt GitHub ?

Recherchez-le ici et copiez l'entrée : @misc pour le BibTeX classique, avec la version dans une note, ou @software pour biblatex. Les deux conservent le nom du logiciel entre doubles accolades pour que ses majuscules soient préservées.

La recherche nécessite-t-elle un compte GitHub ?

Non. Elle utilise l'API publique de GitHub et lit le fichier CITATION.cff sur raw.githubusercontent.com directement depuis votre navigateur, en n'envoyant que l'adresse du dépôt. Sans connexion, GitHub autorise 60 requêtes API par heure et par connexion, et une recherche en utilise une ou deux.

Que faire si le dépôt est privé ou hébergé sur GitLab ?

La recherche ne lit que les dépôts GitHub publics. Pour tout autre cas, saisissez les informations dans le formulaire (les citations sont mises en forme de la même façon) ou utilisez le Générateur de citations de logiciels et de code.