📝

GitHubがSWの論文被引用支援を開始

1 min read

はじめに

開発している強化学習のExperience Replay用ライブラリ cpprb を、ありがたいことに論文の参考文献(?)に載せたいから、引用情報をつけてほしいと issue が立ちました。

https://gitlab.com/ymd_h/cpprb/-/issues/139

どのように記載すべきかと調べたところ、とてもタイムリー(2021年8月19日)にGitHubで公式に citation (引用)を支援する機能が追加されてました。

https://current.ndl.go.jp/node/44676

https://github.blog/2021-08-19-enhanced-support-citations-github/

CITATION.cff の作成

GitHubの引用支援機能は、YAML形式のCITATION.cffをプロジェクト直下に配置することで、その情報を利用してBibTeXのエントリー等を構築・コピペできるようにしてくれます。

https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files

CITATION.cffに記載すべき情報は以下に整理されています。
(cff-version: 1.1.0 までは、READMEに直接記載されていましたが、cff-version: 1.2.0 からはこちらに移動しているみたいです。)

https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md

公式の情報を見ながら必要そうな情報を以下のように記載しました。(まあ、BibTeXのエントリーには反映されていない情報がたくさんあるんですが、きちんと書いておけばそのうち活用されるのでしょう。)

CITATION.cff
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Yamada
    given-names: Hiroyuki
title: "cpprb"
license: MIT
repository-code: "https://gitlab.com/ymd_h/cpprb"
type: software
url: "https://ymd_h.gitlab.io/cpprb/"
date-released: "2019-01-12"


GitHub上でcitationをコピーするポップアップウィンドウ

生成されたBibTeXエントリー
@misc{Yamada_cpprb_2019,
author = {Yamada, Hiroyuki},
month = {1},
title = {{cpprb}},
url = {https://gitlab.com/ymd_h/cpprb},
year = {2019}
}

おわりに

簡単に参考文献用の引用情報を設定できるので、科学論文等に利用されうるSWを開発している人にはおすすめです。

今回しっかりと調査しきれていませんが、どうやらZenodoZoteroがGitHub上のCITATION.cffをサポートしているようです。

https://citation-file-format.github.io/

Discussion

ログインするとコメントできます