Pytanie:
Jak cytujesz repozytorium Github?
charlespwd
2013-11-11 20:35:55 UTC
view on stackexchange narkive permalink

Pracuję nad wyróżnieniem i opracowałem bibliotekę Fortran, którą chciałbym zacytować.

W niektórych miejscach sugerują cytowanie dokumentacji projektu, ale to jest coś, co planuję do zrobienia w przyszłości i jeszcze się nie skończył. Jedyną dokumentacją, jaką mam w tej chwili, jest plik README i sam kod.

Jaki byłby dopuszczalny sposób skierowania czytelnika do mojej pracy na Githubie?

(bonus) Czy istnieje sposób na BibTeX to?

Myślę, że odpowiedź energynumbers jest poprawna w kategoriach tego, co jest „poprawne” w literaturze akademickiej. Jeśli jednak natychmiastowym problemem jest „Muszę pozwolić czytelnikowi pracy / rozprawy, nad którą teraz pracuję, zobaczyć oprogramowanie”, to (jak się wydaje mało skomplikowane) można rozważyć włączenie kodu źródłowego do pliku dodatek. To, jak praktyczne jest to, może zależeć od jego długości ... Albo zapytaj swojego przełożonego, czy jest zadowolony z udostępnienia linku do github i jaki powinien być jego format. Witamy w Stackexchange :-)
@charlespwd Witamy w Academia.SE! :) Zmodyfikowałem nieco pytanie, aby działało dobrze ze sposobem zadawania pytań w StackExchange (dzięki czemu można uzyskać najlepsze odpowiedzi). Mam nadzieję, że nie masz nic przeciwko. Jeśli tak, po prostu cofnij moje zmiany.
@SimonWaldman: 7 tys. Linii kodu rozłożonych na wiele modułów to definitywnie nie coś, co mogę zawrzeć w załączniku. Mój kolega włączył swój kod MATLAB-a do swojej pracy, ale uznałem to za okropny sposób na udostępnianie kodu, ponieważ nie można go łatwo ponownie wykorzystać (skopiowanie go w Matlabie zignorowałoby tabulowanie itp.).
@charlespwd ha, w porządku. I zgadzam się, że dzielenie się kodem to okropny sposób. Ale jeśli chodzi o pracę dyplomową, a nie opublikowaną pracę, myślę, że poprawną odpowiedzią jest „cokolwiek twój promotor jest zadowolony” ;-)
Zobacz także tę dyskusję: http://lists.software-carpentry.org/pipermail/discuss_lists.software-carpentry.org/2013-October/001048.html
^ Jest tak wiele wspaniałych punktów, które myślę, że warto je ująć w odpowiedź, znacznie lepszą niż wszystkie obecne!
Spójrz na to: [https://github.com/blog/1840-improving-github-for-science]. To może odpowiedzieć przynajmniej na część twojego pytania.
Siedem odpowiedzi:
Piotr Migdal
2013-11-11 23:00:44 UTC
view on stackexchange narkive permalink

Poszedłbym z:

P.W.D. Charles, Tytuł projektu, (2013), repozytorium GitHub, https://github.com/charlespwd/project-title

Lub trochę inaczej, w zależności od Twój styl cytowania. Ważne jest, aby podać: autora, tytuł (jeśli styl to obejmuje), rok i link.

Oczywiście, jeśli masz publikację związaną z tym fragmentem kodu (nawet jeśli tak naprawdę jest Twoja pierwsza publikacja oparta na tym kodzie), nie zapomnij też zacytować! (W obecnym systemie akademickim liczy się wszystko.)

I odpowiedni wpis BibTeX: 

  @misc {Charles2013, autor = {Charles, PWD}, tytuł = {Tytuł projektu}, rok = {2013}, wydawca = {GitHub}, dziennik = {repozytorium GitHub}, howpublished = {\ url {https://github.com/charlespwd/project-title}}, commit = {4f57d6a0e4c030202a07a60bc1bb1ed1544bff }}

Uwaga, to powyżej są improwizacje (zwłaszcza wpis BibTeX), a nie standardy.

Nawet w przypadku bardziej ugruntowanych i cytowanych rzeczy nie ma ustalonych standardów, zobacz np:

Zobacz też:

EDIT:

Zobacz także jak przypisać DOI do konkretnego zatwierdzenia w repozytorium.

Może możemy uzgodnić coś takiego dla normy. Nie rozumiem, dlaczego tradycyjne czasopisma są lepsze niż repozytoria GitHub do publikowania artykułów. W takim przypadku załadowałbym źródła LaTeX do repozytorium i podałbym link do pliku PDF. Naprawdę myślę o zrobieniu tego, jest nawet proces recenzji, a recenzenci mogą otwierać problemy w repozytorium: -m Byłoby to bezpłatne dla autorów i zapewniłoby otwarty dostęp, promowało współpracę itp.
Czy jest jakiś szczególny powód anonimowego głosu przeciw?
Jeśli właściciel repozytorium nie podaje swojego pełnego imienia i nazwiska, czy zasugerowałbyś użycie jego nazwy użytkownika GitHub?
Nie. Poszukałbym jego prawdziwego imienia i nazwiska w innym miejscu.
user7112
2013-11-12 21:52:30 UTC
view on stackexchange narkive permalink

Poproszono mnie o komentarz jako odpowiedź, więc oto jest. To kolejny sposób na cytowanie oprogramowania. Wymaga to jednak pewnego wysiłku ze strony autorów oprogramowania.

Opracowałem narzędzie internetowe typu Open Source do modelowania i gromadzenia danych przy zastosowaniu określonej teorii / metodologii inżynierii oprogramowania. Oto jak byś to zacytował:

Graziotin, D i Abrahamsson, P 2013. Internetowe narzędzie do modelowania dla teorii inżynierii oprogramowania SEMAT Essence. Journal of Open Research Software 1 (1): e4, DOI: http://dx.doi.org/10.5334/jors.ad

Jest to możliwe ponieważ zdecydowałem się opublikować artykuł o oprogramowaniu w Journal of Open Research Software. Jest to czasopismo w pełni Open Access. To czasopismo przyjmuje tylko artykuły dotyczące oprogramowania o oprogramowaniu typu open source do badań .

Dokument dotyczący oprogramowania to specjalny rodzaj papieru, który opisuje oprogramowanie - np. o czym ono jest, implementację i architekturę, jego dostępność i potencjał ponownego wykorzystania. Proces redakcyjny przebiega jak w każdym innym miejscu badawczym, a artykuły są recenzowane.

Opłaty za przetwarzanie artykułu wynoszą 25 GBP. Jednak można z nich w pełni zrezygnować, jeśli nie stać ich na to.

To, co jest fajne w tym podejściu, to fakt, że naukowcy mają dodatkową motywację do otwierania oprogramowania do badań: otrzymują na to publikację oraz cytaty . Dodatkowo, napisanie artykułu o oprogramowaniu jest dużo łatwiejsze niż napisanie artykułu metodologicznego .

Napisałem recenzję czasopisma na moim blogu. TL; DR; Świetne doświadczenie, zrób to.

Niezła recenzja Journal of Open Research Software. Nigdy wcześniej nie słyszałem o tym czasopiśmie i jestem pod wrażeniem twojego opisu procesu recenzowania. Jestem pod szczególnym wrażeniem, że skrytykowali kod. Jeśli ktoś inny to przesłał, czy możesz skomentować?
Dla wyjaśnienia przyszłym odwiedzającym to pytanie. Właśnie dołączyłem do redakcji czasopisma. Jednak ta odpowiedź została napisana, gdy nie było „konkurencyjnych interesów”.
@FaheemMitha Recenzowałem dla JORS i całkowicie zgadzam się z tą odpowiedzią. Tak, sprawdziłem kod zgodnie z wytycznymi recenzenta JORS. Przeglądałem „Software Papers” w tradycyjnych czasopismach branżowych i od czasu do czasu otrzymywałem od redakcji odpowiedź dotyczącą przeglądu kodu oraz artykułu: patrz carlboettiger.info/2013/06/13/what-I-look-for-in- software-papers.html
@cboettig Dzięki za link. Czytałem twój artykuł na blogu. Było dobrze, choć trochę zbyt specyficznie w R. Czy masz pojęcie o obecnym czasie między zgłoszeniem a podjęciem decyzji przez JORS? Osobiście uważam, że dobrą rzeczą jest stworzenie pakietu Debiana dla swojego oprogramowania. Jeśli zostanie wykonany prawidłowo, automatycznie rozwiązuje kilka problemów.
@FaheemMitha Tak, głównie odnosiłem się do komentarza do tego posta, który odzwierciedla różne opinie o recenzowaniu oprogramowania, a nie treść mojego postu; Przepraszam. Tak, pakiety Debiana zapewniają przynajmniej podstawowe metadane, ale wyraźnie nie są na przykład idealne dla odbiorców Windows. Inne systemy pakietów zapewniają inne znaki + i -. JORS sprawia, że ​​autorzy mówią o każdej z tych kwestii.
@cboettig Cóż, najwyraźniej można by stworzyć pakiet Debiana tylko dla dość uniksowego oprogramowania. Większość programów naukowych i tak działałaby tylko na jednym z systemów Windows i Linux.
Dziękuję bardzo za to. Od jakiegoś czasu szukałem alternatywy dla * Computer Physics Communications *, która byłaby kompatybilna z kosztami wiedzy. Wydaje się, że to bardzo ładnie pasuje do rachunku.
Polecam również Journal of Open Source Software, jest to projekt NUMFocus, całkowicie darmowy AFAIK, zaprojektowany tak, aby był przyjazny dla programistów: https://joss.theoj.org/
Shahryar
2014-05-15 18:28:15 UTC
view on stackexchange narkive permalink

Teraz można je w jakiś sposób cytować, udostępniając odniesienia DOI. To było w ich wiadomościach z 14 maja: https://github.com/blog/1840-improving-github-for-science

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

Podstawowym pytaniem wydaje się być to, jak zdobyć oprogramowanie do cytowania.

Jest na to tradycyjna metoda.

Piszesz dokument metodyczny opisujący oprogramowanie, jak to było zbudowany, co robi. Możesz podać kod źródłowy jako informacje dodatkowe.

A następnie cytujesz ten artykuł, w przyszłych artykułach, w których będziesz stosować oprogramowanie.

Myślę, że jako towarzystwo naukowe ważne jest, aby wypracować sposób cytowania innych rzeczy niż publikacja w czasopismach (np. Kod, dane). W przeciwnym razie nauka nigdy nie wkroczy w XXI wiek.
@PiotrMigdal Zgadzam się i mam nadzieję, że * będą * lepsze sposoby cytowania wiedzy spoza czasopism. Jednak tak jest teraz * jest *.
@Trylks Wiem. Więc mój komentarz, a nie negatywny czy cokolwiek innego. Zresztą pytanie brzmi, co zrobić, gdy nie ma towarzyszącego wpisu do dziennika (przy okazji: na razie mam ten sam problem).
Mam jednak nadzieję, że nie sugerujesz, że pozbywamy się recenzowania w XXI wieku? Zaletą tej odpowiedzi jest to, że jeśli połączone repozytorium kodu i dane są połączone z artykułem, było to częścią procesu recenzji. Podczas gdy kiedy cytuję czyjeś rzeczy gdzieś w sieci, może to być naprawdę wszystko. Nie mówię, że recenzowanie jest idealne, ale naprawdę musimy zintegrować je z bardziej nowoczesnymi połączonymi stylami pracy.
albert
2016-04-24 21:42:30 UTC
view on stackexchange narkive permalink

GitHub oferuje teraz cytowanie jako usługę, przynajmniej w przypadku Zenodo. Ten przewodnik zawiera instrukcje, jak połączyć konta i uzyskać DOI w swojej pracy:
https://guides.github.com/activities/citable-code/

Ja też się z tym spotkałem, ale cytowanie cudzego repozytorium nie pomaga.
Trylks
2013-11-11 22:40:31 UTC
view on stackexchange narkive permalink

Najczęściej widziałem przypis z adresem URL, który chcesz podać, w tym przypadku jest to adres URL repozytorium GitHub. To wskaże ludziom jeszcze lepiej, ponieważ będzie na tej samej stronie i na pewno nie będzie się liczyło dla statystyk bibliograficznych i twojego indeksu h, ale i tak nie będzie się liczyło, przynajmniej jeszcze nie.

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

Figshare zapewnia sposób na zaimportowanie wydania GitHub i przypisanie do niego doi. Jeszcze tego nie próbowałem, ale wydaje się, że jest to dobra pośrednia ścieżka między pracą programową a cytowaniem samego repozytorium.



ⓘ
To pytanie i odpowiedź zostało automatycznie przetłumaczone z języka angielskiego.Oryginalna treść jest dostępna na stackexchange, za co dziękujemy za licencję cc by-sa 3.0, w ramach której jest rozpowszechniana.
Loading...