Генератор цитирования GitHub

Ваши ссылки

Найдите репозиторий или введите название программы, чтобы увидеть ссылки.

Как пользоваться генератором цитирования GitHub

1. 1. Вставьте адрес репозитория и нажмите «Найти». Подходит любая форма записи: https://github.com/owner/repository, ссылка на файл внутри него или просто owner/repository.
2. 2. Проверьте, что заполнилось. Из CITATION.cff вы получите авторов, название, версию, дату выпуска и DOI, которые выбрали разработчики. Без него GitHub знает только имя аккаунта и последний выпуск — добавьте настоящих авторов, если проект их указывает.
3. 3. Сохраните DOI. Если выпуск заархивирован в Zenodo или другом репозитории, его DOI постоянен, и все стили предпочитают его адресу GitHub.
4. 4. Скопируйте ссылки. Если в CITATION.cff назван труд для цитирования, его ссылки появятся после ссылок на программу — многие проекты просят указывать и то, и другое.

Что даёт файл CITATION.cff

CITATION.cff — это небольшой файл YAML в корне репозитория, который говорит, как цитировать программу, в формате Citation File Format (версия 1.2.0). GitHub читает его, чтобы показать кнопку «Cite this repository» с APA и BibTeX, а этот инструмент читает те же ключи:

Цитирование программ в APA, MLA и Chicago

APA 7 (§10.10) цитирует программу с версией в скобках и описанием [Computer software] после названия, затем издателя и DOI или URL. У APA нет примера для GitHub, поэтому GitHub выступает издателем, если выпуск не заархивирован в другом месте. MLA 9 строит запись из основных элементов: в заметке MLA Style Center о цитировании исходного кода владелец репозитория считается автором, написание названия программы сохраняется точно, указывается версия, а GitHub становится вторым контейнером перед URL. Chicago 18 (§14.169) указывает программу в библиографии под именем разработчика, с версией и издателем. В классическом BibTeX у @misc нет поля версии, поэтому версия идёт в примечание; у biblatex есть отдельный тип @software.

Примеры цитат GitHub

Сама спецификация Citation File Format, чей CITATION.cff перечисляет девять авторов, версию 1.2.0, дату выпуска 9 августа 2021 года и DOI 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}
}

В CITATION.cff библиотеки Matplotlib также просят цитировать статью Джона Д. Хантера 2007 года. Инструмент оформляет и эту предпочтительную ссылку:

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

Когда в репозитории нет CITATION.cff

Без CITATION.cff инструмент берёт публичные данные репозитория на GitHub: имя репозитория как название, аккаунт владельца как автора, а также тег и дату последнего выпуска, если он есть. Это отправная точка, а не готовая ссылка: ищите авторов в README или на сайте проекта и указывайте версию, которую вы действительно использовали. Без входа в аккаунт GitHub разрешает 60 запросов API в час с одного подключения, а поиск расходует один-два; если лимит исчерпан, инструмент сообщит, когда он сбросится, и вы сможете заполнить форму вручную. Если вы сопровождаете репозиторий, добавьте CITATION.cff — тогда все его ссылки будут единообразны. Генератор цитирования программного обеспечения охватывает программы, которых нет на GitHub.

Типичные ошибки

• Указание имени аккаунта как автора. «numpy» — это аккаунт; авторы — люди или команда, которых называет проект.
• Пропуск версии. Код меняется между выпусками. Укажите версию, тег или коммит, которые вы использовали.
• Использование адреса GitHub при наличии DOI. DOI заархивированного выпуска не ломается, если репозиторий переезжает.
• Игнорирование предпочтительной ссылки. Если разработчики просят процитировать их статью, цитируйте её — обычно вместе с программой.
• «Исправление» заглавных букв в названии программы. pandas, NumPy и scikit-learn пишутся так, как их пишут разработчики.

Часто задаваемые вопросы

Как процитировать репозиторий GitHub в APA 7?

Цитируйте его как программу: авторы, год выпуска, название курсивом, версия в скобках, [Computer software], издатель и ссылка. Без архива издатель — GitHub, а ссылка — адрес репозитория; при DOI Zenodo издатель — Zenodo, а ссылка — DOI. В тексте: (Druskat et al., 2021).

Что такое файл CITATION.cff?

Это текстовый файл YAML в корне репозитория, который говорит людям, как цитировать программу, в формате Citation File Format. Он содержит авторов, название, версию, дату выпуска и DOI и может назвать статью для цитирования вместо программы. GitHub превращает его в кнопку «Cite this repository».

Цитировать программу или статью о ней?

Следуйте пожеланиям разработчиков из CITATION.cff. Многие просят статью, а руководство Citation File Format отмечает, что программное обеспечение заслуживает признания наравне с любым другим результатом исследования, поэтому часто цитируют оба: статью за метод, программу за версию, которую вы запускали.

Как получить запись BibTeX для репозитория GitHub?

Найдите репозиторий здесь и скопируйте запись: @misc для классического BibTeX, с версией в примечании, или @software для biblatex. Оба варианта сохраняют название программы в двойных фигурных скобках, чтобы его заглавные буквы сохранились.

Нужен ли аккаунт GitHub для поиска?

Нет. Инструмент использует публичный API GitHub и читает файл CITATION.cff с raw.githubusercontent.com прямо из вашего браузера, отправляя только адрес репозитория. Без входа GitHub разрешает 60 запросов API в час с одного подключения, а поиск расходует один-два.

Что делать, если репозиторий закрытый или на GitLab?

Поиск читает только публичные репозитории GitHub. Для всего остального введите данные в форму — ссылки оформляются так же — или воспользуйтесь Генератором цитирования программного обеспечения.