Generator przypisów GitHub

Twoje cytowania

Wyszukaj repozytorium albo wpisz nazwę oprogramowania, aby zobaczyć cytowania.

Jak korzystać z generatora przypisów GitHub

1. 1. Wklej adres repozytorium i naciśnij Wyszukaj. Działa każda forma: https://github.com/owner/repository, link do pliku wewnątrz repozytorium albo sama nazwa owner/repository.
2. 2. Sprawdź, co zostało wypełnione. Z pliku CITATION.cff otrzymasz autorów, tytuł, wersję, datę wydania i DOI wybrane przez twórców. Bez niego GitHub zna tylko nazwę konta i najnowsze wydanie — dodaj prawdziwych autorów, jeśli projekt ich podaje.
3. 3. Zachowaj DOI. Gdy wydanie jest zarchiwizowane w Zenodo lub innym repozytorium, jego DOI jest trwałe, a każdy styl preferuje je przed adresem GitHub.
4. 4. Skopiuj cytowania. Jeśli plik CITATION.cff wskazuje pracę do zacytowania, jej cytowania pojawią się po cytowaniach oprogramowania — wiele projektów prosi o oba.

Co daje plik CITATION.cff

CITATION.cff to niewielki plik YAML w katalogu głównym repozytorium, który określa, jak cytować oprogramowanie, w formacie Citation File Format (wersja 1.2.0). GitHub odczytuje go, aby pokazać przycisk „Cite this repository” z APA i BibTeX, a to narzędzie odczytuje te same klucze:

Cytowanie oprogramowania w APA, MLA i Chicago

APA 7 (§10.10) podaje oprogramowanie z wersją w nawiasie i opisem [Computer software] po tytule, a następnie wydawcę i DOI lub adres URL — APA nie ma przykładu dla GitHub, więc GitHub pełni rolę wydawcy, chyba że wydanie jest zarchiwizowane gdzie indziej. MLA 9 buduje wpis z jego podstawowych elementów; wpis MLA Style Center o cytowaniu kodu źródłowego traktuje właściciela repozytorium jako autora, zachowuje wielkość liter nazwy oprogramowania, podaje wersję i ustawia GitHub jako drugi kontener przed adresem URL. Chicago 18 (§14.169) wymienia oprogramowanie pod nazwiskiem twórcy w bibliografii, z wersją i wydawcą. W BibTeX klasyczny @misc nie ma pola wersji, więc wersja trafia do notatki; biblatex ma właściwy typ @software.

Przykłady dla repozytorium GitHub

Sama specyfikacja Citation File Format, której plik CITATION.cff wymienia dziewięciu autorów, wersję 1.2.0, datę wydania 9 sierpnia 2021 roku i DOI z 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}
}

Plik CITATION.cff projektu Matplotlib prosi też o zacytowanie artykułu Johna D. Huntera z 2007 roku. Narzędzie formatuje także to preferowane cytowanie:

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

Gdy repozytorium nie ma pliku CITATION.cff

Bez pliku CITATION.cff narzędzie korzysta z publicznych danych repozytorium GitHub: nazwy repozytorium jako tytułu, konta właściciela jako autora oraz znacznika i daty najnowszego wydania, jeśli istnieje. To punkt wyjścia, a nie gotowe cytowanie — poszukaj autorów w README lub na stronie projektu i podaj wersję, której faktycznie używasz. Bez logowania GitHub pozwala na 60 zapytań API na godzinę z jednego połączenia, a wyszukiwanie zużywa jedno lub dwa; po przekroczeniu limitu narzędzie podaje, kiedy się zresetuje, a formularz możesz wypełnić ręcznie. Jeśli utrzymujesz repozytorium, dodanie pliku CITATION.cff sprawi, że każde jego cytowanie będzie spójne — Generator przypisów do oprogramowania i kodu obejmuje programy spoza GitHub.

Częste błędy

• Podawanie nazwy konta jako autora. „numpy” to konto; autorami są osoby lub zespół, które projekt wymienia.
• Pominięcie wersji. Kod zmienia się między wydaniami. Podaj wersję, tag wydania lub commit, z których korzystasz.
• Używanie adresu GitHub, gdy jest DOI. DOI zarchiwizowanego wydania nie przestaje działać, gdy repozytorium się przenosi.
• Ignorowanie preferowanego cytowania. Jeśli twórcy proszą o zacytowanie ich artykułu, zacytuj go — zwykle obok oprogramowania.
• „Poprawianie” wielkich liter w nazwie oprogramowania. pandas, NumPy i scikit-learn zapisujemy tak, jak piszą je ich twórcy.

Najczęstsze pytania

Jak zacytować repozytorium GitHub w APA 7?

Zacytuj je jak oprogramowanie: autorzy, rok wydania, nazwa kursywą, wersja w nawiasie, [Computer software], wydawca i link. Bez archiwum wydawcą jest GitHub, a linkiem adres repozytorium; przy DOI z Zenodo wydawcą jest Zenodo, a linkiem DOI. W tekście: (Druskat et al., 2021).

Czym jest plik CITATION.cff?

Zwykłym plikiem YAML w katalogu głównym repozytorium, który informuje, jak cytować oprogramowanie, w formacie Citation File Format. Zawiera autorów, tytuł, wersję, datę wydania i DOI i może wskazać artykuł do zacytowania zamiast niego. GitHub zamienia go na przycisk „Cite this repository”.

Czy cytować oprogramowanie, czy artykuł o nim?

Stosuj się do życzeń twórców zapisanych w CITATION.cff. Wielu prosi o artykuł, a przewodnik po Citation File Format zauważa, że oprogramowanie zasługuje na uznanie jak każdy inny wynik badań, więc częste jest cytowanie obu: artykułu za metodę, a oprogramowania za wersję, której użyto.

Jak uzyskać wpis BibTeX dla repozytorium GitHub?

Wyszukaj je tutaj i skopiuj wpis: @misc dla klasycznego BibTeX z wersją w notatce albo @software dla biblatex. Oba zachowują nazwę oprogramowania w podwójnych nawiasach klamrowych, aby przetrwały wielkie litery.

Czy wyszukiwanie wymaga konta GitHub?

Nie. Narzędzie korzysta z publicznego interfejsu API GitHub i odczytuje plik CITATION.cff z raw.githubusercontent.com bezpośrednio z przeglądarki, wysyłając tylko adres repozytorium. Bez logowania GitHub pozwala na 60 zapytań API na godzinę z jednego połączenia, a wyszukiwanie zużywa jedno lub dwa.

Co, jeśli repozytorium jest prywatne albo na GitLab?

Wyszukiwanie czyta tylko publiczne repozytoria GitHub. W pozostałych przypadkach wpisz dane do formularza — cytowania są formatowane tak samo — albo skorzystaj z Generatora przypisów do oprogramowania i kodu.