論文を GitHub に置く

初期化、補助ファイルの除外、非公開リポジトリ、共著者とのマージを穏やかに保つ習慣。

論文を GitHub に置く

LaTeX の原稿はプレーンテキストなので、Git との相性は抜群です。下書きの 1 つ 1 つがコミットとして残り、いつでも戻れます。変更はすべて行単位の差分で見えます。GitHub は、離れた場所のバックアップと、共著者が最新の状態を取得する手段を提供してくれます。どれも、高度な Git の知識は必要ありません。論文に必要なのは、せいぜい 5 つのコマンドを、一貫して使うことです。

最初のセットアップ

ターミナルウィンドウ
git init
# add a .gitignore for *.aux *.log *.out *.toc *.synctex.gz
git add main.tex refs.bib figures/
git commit -m "Initial manuscript"
gh repo create my-paper --private --source=. --push

これは、プロジェクトのフォルダーで一度だけ実行します。.gitignore の手順は、見かけ以上に重要です。コンパイルのたびに .aux、.log、.out、.toc、.synctex.gz のファイルが再生成されます。これらをコミットすると、本当の変更が機械的なノイズに埋もれ、共著者の間で無意味なマージコンフリクトが起きます。追跡するのは、自分で書いたものだけにします。.tex のソース、.bib データベース、図、そして投稿先が配布したクラスやスタイルのファイルです。PDF もビルドの生成物です。たいていのチームは PDF を除外し、ローカルで再ビルドしますが、タグを付けたリリースに PDF を添付すれば、投稿した版を固定する妥当な方法になります。成果が公開されるまでは、リポジトリを非公開にしておきましょう。未公開の原稿は、検索エンジンに載せるものではありません。

共著者との作業を穏やかに保つ習慣

1 つのコミットは 1 つの論理的な変更にします。たとえば「第 3 節の導入を改訂」や「アブレーションの表を追加」のようにします。そうすれば履歴が論文の物語として読め、まずい編集があっても、巻き添えなしに元へ戻せます。執筆セッションを始める前に pull し、終えるときに push します。マージコンフリクトは、ブランチが離れている時間とともに増えます。共著者がすでに pull した共有ブランチには、決して force-push しないでください。足元の履歴を書き換えてしまうからです。大きなバイナリ成果物(データセットや動画)は、論文のリポジトリに入れません。アーカイブにリンクするか、データ専用のリポジトリを別に用意します。Git は、すべてのバイナリのあらゆる版を、永遠に保存するからです。

LaTeX に特有の習慣が 1 つあります。ソースの 1 行に 1 文を書くと、差分がぐっと読みやすくなります。1 語の修正が、段落全体の再配置ではなく、1 行の変更として表示されるからです。

Oleafly との組み合わせ

Oleafly のプロジェクトはどれもディスク上の普通のフォルダーなので、これらのコマンドはそのまま使えます。Oleafly は、ソースが変更された成功ビルドのうち条件を満たすものを、Git とは別に保存したチェックポイントとして保持します。ソース管理で意図的にコミットし、共同作業者と push や pull を行ってください。Git の履歴を参照してください。これを土台にした共同作業のパターン(パッチのやり取りや章の担当分けなど)は、ライブカーソルなしの共著を参照してください。

ローカルスタジオ に戻る