📝

研究者に向けた GitHub のススメ

に公開

GitHubを使ってみて、めちゃくちゃいいと思った

理由を三つ書く。

  1. 研究は不完全な世界である 不完全さ、未来の読めなさに対応できる
  2. 思考が整理できる
  3. コードを書くのが上手くなった

この記事では、特に、2. について書く。

2. 思考の整理ができる

研究をやっていると、思いついたことを試すことが多い。
GitHub では、次に追加することをまずイシューに記入する。
そして、実装を行なって、プルリクエストでマージを行う。
ここで、重要なのが、イシューに記入するということである。

手順は以下の通りである。
第一に、イシューに「論文にXXXの引用を追加したい」などと書く。
第二に、本文に追加する文章を書く:「モデルには、XXXを用いる~\cite{XXX2021}。」。
また、追加するbibtexをイシューにコメントとして掲示する。

@XXX2021 {
    title = {XXX}
    ...
}

第三に、イシューのコメントに記載された内容を、実際のコードに反映する。

ここで、重要なのは、第一から第二の箇所で、思考が整理できるため、かなり効率よく書けるのである。

GitHub を勉強するのに良かった書籍を載せておく。
https://amzn.asia/d/c5NCatV

この本は、非エンジニアのブロガーさんが書いている。
そのため、エンジニアではない研究者が、プログラムや論文を書く際に、有益だった。
複数ブランチの作業を読むと、複数の作業を同時に行っても、こんがらないようになる。
研究者は、引用の追加と図の修正などを同時に進めたりする。
GitHubを使うと、自然と非常に上手く整理できて、ストレスも減るし、仕事もよく進む。

Discussion