Как вы цитируете репозиторий Github?

Я работаю над диссертацией с отличием и разработал библиотеку Fortran, которую я хотел бы процитировать в ней.

Кое-где предлагают цитировать документацию проекта, но это то, что я планирую сделать в будущем и еще не сделано. Единственная документация, которая у меня есть сейчас, это файл README и сам код.

Что было бы приемлемым способом направить читателя к моей работе на Github?

(бонус) Есть ли способ BibTeX сделать это?

Я думаю, что ответ EnergyNumbers правильный с точки зрения того, что является «правильным» в академической литературе. Однако, если непосредственная проблема заключается в том, что «мне нужно, чтобы читатель диссертации/диссертации, над которой я сейчас работаю, увидел программное обеспечение», то (как кажется низкотехнологичным) вы могли бы рассмотреть возможность включения исходного кода в приложение. Насколько это практично, может зависеть от его длины ... Или спросите своего руководителя, будут ли они рады, если вы предоставите ссылку на github и какой формат должен быть. Кроме того, добро пожаловать на Stackexchange :-)
@charlespwd Добро пожаловать в Academia.SE! :) Я немного отредактировал вопрос, чтобы он хорошо работал со способом задавать вопрос StackExchange (чтобы вы могли получить лучшие ответы). Я надеюсь, что вы не против. Если вы это сделаете, просто отмените мои изменения.
@SimonWaldman: 7 тысяч строк кода, разбросанных по нескольким модулям, — это определенно не то, что я могу включить в приложение. Мой коллега включил свой код MATLAB в свою диссертацию, но я обнаружил, что это ужасный способ поделиться кодом, поскольку вы не можете легко использовать его повторно (копирование в Matlab игнорирует табуляцию и т. д.).
@charlespwd ха, достаточно честно. И я согласен, что это ужасный способ делиться кодом. Но если это для экзаменационной диссертации, а не для опубликованной статьи, я думаю, что правильный ответ - «все, что нравится вашему руководителю» ;-)
См. также это обсуждение: lists.software-carpentry.org/pipermail/…
^ Есть так много замечательных моментов, я думаю, их стоит собрать в ответ, намного лучше, чем все текущие!
Взгляните на это: [ github.com/blog/1840-improving-github-for-science] . Это может ответить хотя бы на часть вашего вопроса.

Ответы (8)

GitHub добавил встроенную поддержку цитирования ( https://twitter.com/natfriedman/status/1420122675813441540 ). Просто добавьте CITATION.cffфайл ( https://citation-file-format.github.io/ ) в свой репозиторий, и виджет цитирования будет добавлен на боковую панель:

введите описание изображения здесь

Я бы пошел с:

PWD Charles, Название проекта, (2013 г.), репозиторий GitHub, https://github.com/charlespwd/project-title

Или немного по-другому, в зависимости от вашего стиля цитирования. Важно только указать: автора, название (если это предусмотрено стилем), год и ссылку.

Конечно, если у вас есть публикация, связанная с этим фрагментом кода (даже если только по факту, что это ваша первая публикация, основанная на этом коде), не забудьте процитировать и ее! (В нынешней академической системе это все, что имеет значение.)

И соответствующая запись BibTeX:

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

Осторожно, это импровизация (особенно запись BibTeX), а не стандарты.

Даже для более устоявшихся и цитируемых вещей не установлены стандарты, см., например:

Смотрите также:

РЕДАКТИРОВАТЬ:

См. также , как присвоить DOI конкретной фиксации в вашем репозитории .

Может быть, мы можем договориться о чем-то подобном для стандарта. Я не понимаю, почему традиционные журналы лучше репозиториев GitHub для публикации статей. В этом случае я бы загрузил исходники LaTeX в репозиторий и предоставил ссылку на PDF. Я серьезно думаю об этом, есть даже некоторый процесс рецензирования, и рецензенты могут открывать задачи в репозитории :-m Это было бы бесплатно для авторов и предоставляло бы открытый доступ, способствовало бы сотрудничеству и т.д.
Если владелец репозитория не сообщает свое полное имя, не могли бы вы предложить вместо этого использовать свое имя пользователя GitHub?
Нет. Я бы поискал его настоящее имя в другом месте.
Некоторые пользователи github не используют свое настоящее имя, что затрудняет его поиск.
Почему бы не использоватьurl={https://github.com/charlespwd/project-title}
Какой год в случае, если я имею в виду не конкретный коммит, а репо в целом?
@Trylks - понимаете, что ваш комментарий от 2013 года, но Журнал программного обеспечения с открытым исходным кодом (JOSS) делает все свои обзоры на github. См. , например, github.com/openjournals/joss-reviews/issues/4368 .

Меня попросили предоставить мой комментарий в качестве ответа, так что вот он. Это еще один способ цитирования программного обеспечения. Однако это требует определенных усилий от авторов программного обеспечения.

Я разработал веб-инструмент с открытым исходным кодом для моделирования и сбора данных, следуя определенной теории/методологии разработки программного обеспечения. Вот как бы вы это процитировали:

Грациотин, Д. и Абрахамссон, П. 2013. Веб-инструмент моделирования для теории разработки программного обеспечения SEMAT Essence. Journal of Open Research Software 1(1):e4, DOI: http://dx.doi.org/10.5334/jors.ad

Это возможно, потому что я решил опубликовать статью о программном обеспечении в Journal of Open Research Software . Это журнал с полностью открытым доступом. Этот журнал принимает только статьи о программном обеспечении с открытым исходным кодом для исследований .

Документ по программному обеспечению — это особый вид документа, в котором описывается программное обеспечение, например, что это такое, реализация и архитектура, его доступность и потенциал повторного использования. Редакционный процесс работает так же, как и в любом другом исследовательском центре, а статьи рецензируются.

Плата за обработку статьи составляет 25 фунтов стерлингов. Однако от них можно полностью отказаться, если вы не можете себе их позволить.

Что хорошо в этом подходе, так это то, что у исследователей есть дополнительная мотивация открыть свое программное обеспечение для исследования: они получают за это публикацию плюс цитирование. Кроме того, написать статью о программном обеспечении намного проще, чем написать статью о методологии .

Я написал рецензию на журнал в своем блоге . TL;ДР; Отличный опыт, дерзайте.

Хороший обзор журнала Open Research Software. Я никогда раньше не слышал об этом журнале, и я впечатлен вашим описанием процесса рецензирования. Я особенно впечатлен тем, что они критиковали код. Если кто-то еще представил там, вы можете прокомментировать?
Просто чтобы уточнить, для будущих посетителей этого вопроса. Я только что присоединился к редколлегии журнала. Однако этот ответ был написан, когда не было «конкурирующих интересов».
@FaheemMitha Я просмотрел JORS и полностью согласен с этим ответом. Да, я просмотрел код в соответствии с рекомендациями JORS для рецензентов. Я просматривал «Статьи о программном обеспечении» в традиционных журналах, посвященных предметной области, и время от времени получал отказ от редакции за мой обзор кода, а также статьи: см. carlboettiger.info/2013/06/13/what-I-look-for-in- software-papers.html
@cboettig Спасибо за ссылку. Я прочитал вашу статью в блоге. Это было хорошо, хотя и слишком специфично для R. Есть ли у вас какое-либо представление о текущем времени между подачей заявки и принятием решения по JORS? Лично я считаю, что неплохо было бы создать пакет Debian для своего программного обеспечения. Если все сделано правильно, это автоматически решает кучу проблем.
@FaheemMitha Да, я в основном имел в виду строку комментария к этому сообщению, которая отражает различные мнения об обзоре программного обеспечения, а не содержание моего сообщения; извини. Да, пакеты Debian гарантируют предоставление по крайней мере базовых метаданных, но явно не идеальны, например, для пользователей Windows. Другие системы пакетов предоставляют другие плюсы и минусы. JORS заставляет авторов говорить о каждом из этих вопросов.
@cboettig Ну, очевидно, что пакет Debian можно было бы сделать только для программного обеспечения Unixy. Большинство научных программ в любом случае будет работать только на одной из Windows или Linux.
Спасибо вам большое за это. Я некоторое время искал альтернативу Computer Physics Communications , которая была бы совместима с ценой знаний. Кажется, это очень хорошо отвечает всем требованиям.
Я бы также рекомендовал Журнал программного обеспечения с открытым исходным кодом, это проект NUMFocus, совершенно бесплатный, насколько мне известно, и предназначенный для разработчиков: joss.theoj.org

Теперь их можно как-то цитировать, предоставляя ссылки DOI. Это было в их новостях от 14 мая: https://github.com/blog/1840-improving-github-for-science .

GitHub теперь предлагает цитирование как услугу, по крайней мере, с Zenodo. В этом руководстве рассказывается, как подключить свои учетные записи и получить DOI с вашей работой:
https://guides.github.com/activities/citable-code/

Я тоже столкнулся с этим, но цитировать чужой репозиторий не помогает.

Основной вопрос, по-видимому, заключается в том, как получить цитируемое программное обеспечение.

Для этого существует традиционный метод.

Вы пишете методологию, описывающую программное обеспечение, как оно было создано и что оно делает. Вы можете предоставить исходный код в качестве дополнительной информации.

И затем вы цитируете эту статью в будущих статьях, где вы применяете программное обеспечение.

Я думаю, что научному сообществу крайне важно разработать способ цитирования других вещей, помимо журнальных публикаций (например, кода, данных). В противном случае наука никогда не переместится в XXI век.
@PiotrMigdal Я согласен и надеюсь, что будут лучшие способы цитировать нежурнальные знания. Однако это то, что есть сейчас .
@Trylks Я знаю. Так что мой комментарий, а не отрицательный голос или что-то в этом роде. В любом случае, вопрос в том, что делать, когда нет сопроводительной записи в журнале (кстати: на данный момент у меня такая же проблема).
Я надеюсь, что вы не подразумеваете, что мы избавимся от рецензирования в 21 веке? Хорошая вещь с этим ответом заключается в том, что если связанный репозиторий кода и данные связаны с документом, то это было частью процесса проверки. Хотя когда я просто цитирую чей-то материал где-то в сети, на самом деле это может быть что угодно. Я не говорю, что рецензирование идеально, но что нам действительно нужно интегрировать его с более современными взаимосвязанными стилями работы.

Чаще всего я видел сноску с URL-адресом, который вы хотите предоставить, в данном случае URL-адрес вашего репозитория GitHub. Это еще лучше укажет людям, потому что будет на той же странице, и, конечно, это не будет учитываться в библиографической статистике и вашем h-индексе, но в любом случае это не будет учитываться, по крайней мере, пока.

Figshare предоставляет способ импортировать выпуск GitHub и присваивает ему doi. Я еще не пробовал это, но, похоже, это хороший средний путь между документом по программному обеспечению и цитированием только репозитория.