GitHub-citatiegenerator

Jouw bronvermeldingen

Zoek een repository op, of vul de naam van de software in om je bronvermeldingen te zien.

Zo gebruik je de GitHub-citatiegenerator

1. 1. Plak het adres van de repository en druk op Opzoeken. Elke vorm werkt: https://github.com/owner/repository, een link naar een bestand erin, of gewoon owner/repository.
2. 2. Controleer wat er is ingevuld. Uit een CITATION.cff haal je de auteurs, titel, versie, releasedatum en DOI die de ontwikkelaars hebben gekozen. Zonder dat bestand weet GitHub alleen de accountnaam en de laatste release — voeg de echte auteurs toe als het project ze vermeldt.
3. 3. Bewaar de DOI. Wanneer de release is gearchiveerd op Zenodo of een andere repository, is de DOI blijvend, en geven alle stijlen daar de voorkeur aan boven het GitHub-adres.
4. 4. Kopieer je bronvermeldingen. Als het CITATION.cff een artikel noemt dat je moet citeren, staan de bronvermeldingen daarvoor na die van de software — veel projecten vragen om beide.

Wat een CITATION.cff-bestand je geeft

CITATION.cff is een klein YAML-bestand in de hoofdmap van een repository dat zegt hoe de software moet worden geciteerd, in het Citation File Format (versie 1.2.0). GitHub leest het om een knop “Cite this repository” met APA en BibTeX te tonen, en deze tool leest dezelfde sleutels:

Software citeren in APA, MLA en Chicago

APA 7 (§10.10) citeert software met de versie tussen haakjes en de omschrijving [Computer software] na de titel, daarna de uitgever en een DOI of URL — APA heeft geen GitHub-voorbeeld, dus GitHub staat als uitgever tenzij de release elders is gearchiveerd. MLA 9 bouwt het item op uit zijn kernelementen. Het bericht van het MLA Style Center over het citeren van broncode behandelt de eigenaar van de repository als auteur, houdt de hoofdletters van de software precies zoals ze zijn, geeft de versie, en maakt GitHub een tweede container vóór de URL. Chicago 18 (§14.169) zet software in de bibliografie onder de ontwikkelaar, met de versie en de uitgever. In BibTeX heeft de klassieke @misc geen veld voor de versie, dus de versie gaat in een notitie; biblatex heeft een echt @software-type.

Voorbeelden van GitHub-bronvermeldingen

De specificatie van het Citation File Format zelf, waarvan het CITATION.cff negen auteurs, versie 1.2.0, een releasedatum van 9 augustus 2021 en een Zenodo-DOI vermeldt:

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

Het CITATION.cff van Matplotlib vraagt gebruikers ook om het artikel van John D. Hunter uit 2007 te citeren. De tool formatteert die voorkeursbronvermelding ook:

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

Wanneer een repository geen CITATION.cff heeft

Zonder CITATION.cff valt de tool terug op de openbare repositorygegevens van GitHub: de naam van de repository als titel, de accountnaam van de eigenaar als auteur, en de tag en datum van de laatste release, als die er is. Dat is een startpunt, geen afgewerkte bronvermelding — zoek de auteurs in het README of op de website van het project, en citeer de versie die je daadwerkelijk hebt gebruikt. Zonder aan te melden staat GitHub 60 API-verzoeken per uur vanaf één verbinding toe, en een opzoekactie gebruikt er één of twee; als je de limiet bereikt, vertelt de tool wanneer die weer wordt vrijgegeven, en kun je het formulier met de hand invullen. Als je de repository beheert, maakt een CITATION.cff elke bronvermelding ervan consistent — de Software- en Codecitatiegenerator behandelt programma's die niet op GitHub staan.

Veelgemaakte fouten

• De accountnaam als auteur citeren. “numpy” is een account; de auteurs zijn de personen of het team die het project noemt.
• De versie weglaten. Code verandert tussen releases. Geef de versie, releasetag of commit die je hebt gebruikt.
• De GitHub-URL gebruiken terwijl er een DOI is. De DOI van een gearchiveerde release breekt niet wanneer een repository verhuist.
• Het voorkeursartikel negeren. Als de ontwikkelaars vragen hun artikel te citeren, citeer het — meestal naast de software.
• De hoofdletters van een softwarenaam “corrigeren”. pandas, NumPy en scikit-learn worden geschreven zoals hun ontwikkelaars dat doen.

Veelgestelde vragen

Hoe citeer ik een GitHub-repository in APA 7?

Citeer het als software: de auteurs, het jaar van de release, de naam cursief, de versie tussen haakjes, [Computer software], de uitgever en de link. Zonder archief is de uitgever GitHub en is de link de URL van de repository; met een Zenodo-DOI is de uitgever Zenodo en is de link de DOI. In de tekst: (Druskat et al., 2021).

Wat is een CITATION.cff-bestand?

Een platte-tekst YAML-bestand in de hoofdmap van een repository dat mensen vertelt hoe ze de software moeten citeren, in het Citation File Format. Het vermeldt de auteurs, titel, versie, releasedatum en DOI, en kan een artikel noemen om in plaats daarvan te citeren. GitHub maakt er de knop “Cite this repository” van.

Moet ik de software citeren of het artikel erover?

Volg de wensen van de ontwikkelaars in het CITATION.cff. Veel projecten vragen om het artikel, en de gids van het Citation File Format merkt op dat software net als elk ander onderzoeksresultaat erkenning verdient, dus beide citeren is gebruikelijk — het artikel voor de methode, de software voor de versie die je hebt gebruikt.

Hoe krijg ik een BibTeX-item voor een GitHub-repository?

Zoek het hier op en kopieer het item: @misc voor de klassieke BibTeX, met de versie in een notitie, of @software voor biblatex. Beide houden de naam van de software tussen dubbele accolades, zodat de hoofdletters behouden blijven.

Heb ik een GitHub-account nodig voor de opzoekactie?

Nee. Deze gebruikt de openbare API van GitHub en leest het CITATION.cff-bestand van raw.githubusercontent.com, rechtstreeks vanuit je browser, en stuurt alleen het repositoryadres. Zonder aan te melden staat GitHub 60 API-verzoeken per uur per verbinding toe, en een opzoekactie gebruikt er één of twee.

Wat als de repository privé is of op GitLab staat?

De opzoekactie leest alleen openbare GitHub-repositories. Voor alles andere vul je de gegevens in het formulier in — de bronvermeldingen worden op dezelfde manier geformatteerd — of gebruik je de Software- en Codecitatiegenerator.