Question:
Comment citez-vous un référentiel Github?
charlespwd
2013-11-11 20:35:55 UTC
view on stackexchange narkive permalink

Je travaille sur une thèse d'honneur et j'ai développé une bibliothèque Fortran que j'aimerais y citer.

À certains endroits, ils suggèrent de citer la documentation du projet, mais c'est quelque chose que je prévois à faire à l'avenir et n'est pas encore terminé. La seule documentation que j'ai actuellement est le fichier README et le code lui-même.

Quelle serait une manière acceptable de diriger un lecteur vers mon travail sur Github?

(bonus) Existe-t-il une manière BibTeX de faire ça?

Je pense que la réponse energynumbers est correcte en termes de ce qui est «correct» dans la littérature académique. Cependant, si le problème immédiat est "Je dois laisser un lecteur de la thèse / dissertation sur laquelle je travaille actuellement voir le logiciel", alors (low-tech qu'il semble), vous pouvez envisager d'inclure le code source dans un annexe. La praticité de cette opération peut dépendre de sa longueur ... Ou demandez à votre superviseur s'il est heureux que vous fournissiez un lien github et quel devrait être le format. Aussi, bienvenue sur Stackexchange :-)
@charlespwd Bienvenue sur Academia.SE! :) J'ai édité un peu la question pour qu'elle fonctionne bien avec la manière StackExchange de poser la question (afin que vous puissiez obtenir les meilleures réponses). J'espère que cela ne vous dérange pas. Si vous le faites, annulez simplement mes modifications.
Les lignes de code @SimonWaldman: 7K réparties sur plusieurs modules ne sont définitivement pas quelque chose que je peux inclure dans une annexe. Mon collègue a inclus son code MATLAB dans sa thèse mais j'ai trouvé que c'était un moyen terrible de partager du code car vous ne pouvez pas le réutiliser facilement (le copier dans matlab ignorerait la tabulation, etc.).
@charlespwd ha, assez bien. Et je suis d'accord que c'est une manière terrible de partager du code. Mais si c'est pour une thèse examinable plutôt que pour un article publié, je pense que la bonne réponse est "tout ce dont votre superviseur est satisfait" ;-)
Voir également cette discussion: http://lists.software-carpentry.org/pipermail/discuss_lists.software-carpentry.org/2013-October/001048.html
^ Il y a tellement de bons points que je pense qu'ils valent la peine d'être compilés en une réponse, bien mieux que tous les points actuels!
Jetez un œil à ceci: [https://github.com/blog/1840-improving-github-for-science]. Cela pourrait répondre à au moins une partie de votre question.
Sept réponses:
Piotr Migdal
2013-11-11 23:00:44 UTC
view on stackexchange narkive permalink

J'irais avec:

P.W.D. Charles, Project Title, (2013), dépôt GitHub, https://github.com/charlespwd/project-title

Ou un peu différent, selon votre style de citation. Il est simplement crucial d'inclure: l'auteur, le titre (si le style l'inclut), l'année et le lien.

Bien sûr, si vous avez une publication liée à ce morceau de code (même si ce n'est que de fait, c'est votre première publication basée sur ce code), n'oubliez pas de citer aussi! (Dans le système académique actuel, c'est tout ce qui compte.)

Et l'entrée BibTeX respective: 

  @misc {Charles2013, author = {Charles, PWD}, title = {Project Title}, year = {2013}, publisher = {GitHub}, journal = {GitHub repository}, howpublished = {\ url {https://github.com/charlespwd/project-title}}, commit = {4f57d6a0e4c030202a07a6044c1f679b1ed }}

Attention, ce sont des improvisations (en particulier l'entrée BibTeX), pas des standards.

Même pour des choses plus établies et citables, il n'y a pas de normes définies, voir par exemple:

Voir aussi:

EDIT:

Voir aussi comment faire assignez DOI à un commit particulier dans votre référentiel.

Peut-être pouvons-nous nous entendre sur quelque chose comme ça pour une norme. Je ne vois pas pourquoi les revues traditionnelles sont meilleures que les référentiels GitHub pour publier des articles. Dans ce cas, je téléchargerais les sources LaTeX dans le référentiel et fournirais un lien vers le PDF. Je pense sérieusement à faire cela, il y a même un processus de révision, et les réviseurs peuvent ouvrir des problèmes dans le référentiel: -m Ce serait gratuit pour les auteurs et fournirait un accès ouvert, favoriserait la collaboration, etc.
Une raison particulière pour le vote défavorable anonyme?
Si le propriétaire du dépôt ne fait pas connaître son nom complet, suggéreriez-vous d'utiliser son nom d'utilisateur GitHub à la place?
Non. Je chercherais son vrai nom pour ce nom d'utilisateur ailleurs.
user7112
2013-11-12 21:52:30 UTC
view on stackexchange narkive permalink

On m'a demandé de fournir mon commentaire en guise de réponse, alors le voici. C'est encore une autre façon de citer un logiciel. Cependant, cela demande un certain effort de la part des auteurs du logiciel.

J'ai développé un outil Web Open Source pour la modélisation et la collecte de données en suivant une certaine théorie / méthodologie en génie logiciel. Voici comment vous le citeriez:

Graziotin, D et Abrahamsson, P 2013. Un outil de modélisation Web pour la théorie SEMAT Essence du génie logiciel. Journal of Open Research Software 1 (1): e4, DOI: http://dx.doi.org/10.5334/jors.ad

C'est possible parce que j'ai choisi de publier un article sur les logiciels dans le Journal of Open Research Software. Il s'agit d'un journal entièrement en libre accès. Cette revue n'accepte que les articles de logiciels sur les logiciels open source pour la recherche .

Un article sur les logiciels est un type spécial de papier, qui décrit le logiciel - par exemple, de quoi s'agit-il, sa mise en œuvre et son architecture, sa disponibilité et son potentiel de réutilisation. Le processus éditorial fonctionne comme dans tout autre lieu de recherche et les articles sont évalués par des pairs.

Les frais de traitement de l'article sont de 25GBP. Cependant, ils peuvent être totalement supprimés si vous ne pouvez pas vous les permettre.

Ce qui est bien avec cette approche, c'est que les chercheurs ont une motivation supplémentaire pour ouvrir leur logiciel pour la recherche: ils obtiennent une publication pour cela, ainsi que des citations . De plus, rédiger un article sur un logiciel est bien plus facile que rédiger un article sur la méthodologie .

J'ai rédigé une critique de la revue sur mon blog. TL, DR; Super expérience, foncez.

Belle revue du Journal of Open Research Software. Je n'ai jamais entendu parler de ce journal auparavant et je suis impressionné par votre description de son processus d'examen. Je suis particulièrement impressionné qu'ils aient critiqué le code. Si quelqu'un d'autre a soumis là-bas, pouvez-vous commenter?
Juste pour clarifier, pour les futurs visiteurs de cette question. Je viens de rejoindre le comité de rédaction de la revue. Cependant, cette réponse a été rédigée lorsqu'il n'y avait pas d '"intérêt concurrent".
@FaheemMitha J'ai revu pour le JORS et je suis entièrement d'accord avec cette réponse. Oui, j'ai examiné le code conformément aux directives du réviseur JORS. J'ai révisé des `` Software Papers '' dans des revues de domaine traditionnelles, et j'ai parfois reçu des commentaires éditoriaux pour avoir révisé le code ainsi que l'article: voir carlboettiger.info/2013/06/13/what-I-look-for-in- software-papers.html
@cboettig Merci pour le lien. J'ai lu votre article de blog. C'était bien, mais un peu trop spécifique au R. Avez-vous une idée du délai actuel entre la soumission et une décision pour JORS? Personnellement, je pense qu'une bonne chose à faire est de créer un paquet Debian pour votre logiciel. Si cela est fait correctement, il résout automatiquement un tas de problèmes.
@FaheemMitha Oui, je faisais surtout référence à la chaîne de commentaires sur ce message, qui reflète des opinions variées sur la révision du logiciel, plutôt qu'au contenu de mon message; Pardon. Oui, les packages Debian garantissent qu'au moins des métadonnées de base sont fournies, mais ne sont clairement pas idéales pour un public Windows, par exemple. D'autres systèmes de paquets fournissent d'autres + et -'s. JORS fait parler les auteurs de chacune de ces questions.
@cboettig Eh bien, il est clair que l'on ne ferait un paquet Debian que pour un logiciel assez Unixy. De toute façon, la plupart des logiciels scientifiques ne fonctionneraient que sur l'un des systèmes Windows et Linux.
Merci beaucoup pour ça. Je cherchais depuis un certain temps une alternative à * Computer Physics Communications * compatible avec le coût de la connaissance. Cela semble très bien correspondre au projet de loi.
Je recommande vivement le Journal of Open Source Software, c'est un projet NUMFocus, entièrement gratuit AFAIK, et est conçu pour être convivial pour les développeurs: https://joss.theoj.org/
Shahryar
2014-05-15 18:28:15 UTC
view on stackexchange narkive permalink

Maintenant, ils deviennent en quelque sorte cités en fournissant des références DOI. C'était lors de leur actualité du 14 mai: https://github.com/blog/1840-improving-github-for-science

410 gone
2013-11-11 21:34:46 UTC
view on stackexchange narkive permalink

La question sous-jacente semble être de savoir comment obtenir un logiciel citable.

Il existe une méthode traditionnelle pour le faire.

Vous écrivez un document méthodologique décrivant le logiciel, comment il était construit, ce qu'il fait. Vous pouvez fournir le code source comme information supplémentaire.

Ensuite, vous citez ce article, dans les prochains articles où vous appliquez le logiciel.

Je pense qu'en tant que société scientifique, il est crucial de développer une manière de citer d'autres choses que la publication de revues (par exemple, du code, des données). Sinon, la science n'entrera jamais dans le 21e siècle.
@PiotrMigdal Je suis d'accord et j'espère qu'il * y aura * de meilleures façons de citer les connaissances hors journal. Cependant, c'est ce qu'il y a * est * maintenant.
@Trylks Je sais. Le mien est donc un commentaire, pas un vote défavorable ou quoi que ce soit. Quoi qu'il en soit, la question est de savoir quoi faire quand il n'y a pas d'écriture de journal d'accompagnement (BTW: à partir de maintenant, j'ai le même problème).
J'espère cependant que vous n'impliquez pas que nous nous débarrassons de l'examen par les pairs au 21e siècle? La bonne chose avec cette réponse est que si un référentiel de code lié et des données sont connectés à un article, cela faisait partie du processus de révision. Même si je ne cite que le contenu de quelqu'un quelque part sur le Web, cela peut être n'importe quoi, sans dire que l'évaluation par les pairs est parfaite, mais que nous devons vraiment l'intégrer aux styles de travail interconnectés plus modernes.
albert
2016-04-24 21:42:30 UTC
view on stackexchange narkive permalink

GitHub propose désormais la citation en tant que service, du moins avec Zenodo. Ce guide explique comment connecter vos comptes et obtenir un DOI avec votre travail:
https://guides.github.com/activities/citable-code/

J'ai rencontré cela aussi, mais cela n'aide pas à citer le référentiel de quelqu'un d'autre.
Trylks
2013-11-11 22:40:31 UTC
view on stackexchange narkive permalink

Ce que j'ai vu le plus souvent est une note de bas de page avec l'URL que vous souhaitez fournir, dans ce cas l'URL de votre dépôt GitHub. Cela orientera encore mieux les gens car il sera dans la même page, et il est certain que cela ne comptera pas pour les statistiques bibliographiques et votre h-index, mais cela n'allait pas compter de toute façon, du moins pas encore.

Eekhoorn
2014-05-15 19:44:32 UTC
view on stackexchange narkive permalink

Figshare fournit un moyen d'importer une version de GitHub et lui attribue un doi. Je n'ai pas encore essayé cela, mais cela semble être une bonne voie intermédiaire entre un article sur le logiciel et ne citer que le référentiel.



ⓘ
Ce Q&R a été automatiquement traduit de la langue anglaise.Le contenu original est disponible sur stackexchange, que nous remercions pour la licence cc by-sa 3.0 sous laquelle il est distribué.
Loading...