Outils de recherche 3 min de lecture

Prise en charge des citations provenant des dépôts GitHub.

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

Découvrez comment rendre disponibles des fichiers de citations de style APA ou bibtex à partir de vos référentiels

Comment permets-tu aux autres de citer plus facilement ton travail ?
Dans le cadre du travail universitaire, nous développons souvent des prototypes ou rendons des visualisations de données disponibles via des référentiels. L’une des façons dont nous rendons ces artefacts de recherche disponibles est d’utiliser la plateforme GitHub, qui nous permet non seulement de rendre publics des logiciels, des prototypes ou des données, mais aussi de contrôler leur version.

Cependant, lorsque l’on écrit un article et que l’on souhaite référencer un dépôt GitHub, il peut être un peu difficile de savoir comment référencer au mieux ces dépôts. Dans cette optique, Github a récemment créé un moyen de prendre officiellement en charge les citations vers le référentiel de données ou de code. Cette nouvelle fonctionnalité, développée par GitHub, permet aux chercheurs et universitaires d’informer la communauté et les parties intéressées sur la manière de bien citer leurs référentiels, notamment dans les articles scientifiques.

Pour ce faire, les chercheurs doivent ajouter un nouveau fichier à leur référentiel : CITATION.cff. Selon Arfon Smith, membre de l’équipe Github, les informations contenues dans ce fichier sont utilisées pour créer des liens de citation pratiques de style APA ou BibTeX qui peuvent être référencés par d’autres.

Pour activer cette fonctionnalité dans votre référentiel, vous pouvez simplement créer un fichier nommé CITATION.cff dans votre référentiel. Utilisez l’exemple ci-dessous comme modèle pour votre fichier :

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
You can also use the cffinit website to fill in your citation file information. You can get more information about the cff file format on this page: What is a CITATION.cff file?

Vous pouvez également utiliser le site Web cffinit pour remplir les informations de votre fichier de citation. Vous pouvez obtenir plus d’informations sur le format de fichier cff sur cette page : Qu’est-ce qu’un fichier CITATION.cff ?