研究論文のための Git:共著者とのあいだで実際にうまくいくこと

無視ルール、章ごとの担当、コミットメッセージ、非公開のリモート。そして、本物の Git、フォーク、AI のチェックポイントを備えたリサーチワークスペースが、Git を第二の仕事にせずに論文を復元可能に保つ方法。

研究者は、コードにはすでに Git を使っています。論文はコードによく似ています。プレーンテキスト、インクルード、ビルドの残りかす。原稿をリポジトリに入れるのは、一度やってみれば、聞こえるほど奇妙なことではありません。

ゴミを無視する

LaTeX 向けの無難な .gitignore です。

*.aux
*.log
*.out
*.toc
*.synctex.gz
*.bbl
*.blg
*.fdb_latexmk
*.fls

コミットするのは、.tex、.bib、再生成できない図、そして大学が要求する場合はクラスファイルです。ジャーナルがアーカイブにバイナリを求めない限り、PDF を毎回コミットするのはやめましょう。

エディターが Git を自動で開始してくれる場合は、ビルドのキャッシュと PDF の中間ファイルが無視されていることを確認してください。aux ファイルによる、ノイズだけのコミットが続くと、ログは価値を失います。ログを読まなくなり、何かが壊れたときに履歴が助けてくれなくなります。

行ではなくファイルを担当する

2 人が同じ段落を触ると、マージで苦労します。章やセクションごとの担当制を選んでください。レビューが実際に役立つ規模のグループなら、プルリクエストを使います。

1 つのバッファに複数人がライブで入力するのは、別のツール(ブラウザーの LaTeX エディター)の領分です。Git での共同作業はより遅く、より明示的です。ブランチを切り、プッシュし、レビューします。これは、経緯の記録が必要なときにうまく機能します。今日の午後に 3 人でアブストラクトを一緒に打ち込まなければならないなら、ほかのものを選んでください。

未来の自分が読めるコミットメッセージ

「いろいろ修正」では、3 か月後には役に立ちません。「Transformer に関する関連研究を書き直し」で十分です。2 つの層があると助かります。

  1. 名前を付けるマイルストーン。セクションの下書き、投稿、最終原稿。
  2. 安全のためのチェックポイント。頻繁なスナップショットで、うまくいかなかった午後の作業も取り消せるようにする。

エディターがコンパイル成功後や入力が止まったあとにチェックポイントを作るなら、それは最低限のものと考え、唯一の履歴にはしないでください。セクションが仕上がったときや、下書きが共著者に渡るときには、きちんとしたメッセージを書きます。

非公開のリモート

未発表の成果は、非公開の GitHub や GitLab のプロジェクトに置きます。卒業や研究室の異動は、人々が手当たり次第に使ってきたクラウドエディターのアカウントへのアクセスを失うときです。自分で管理するリモートが、バックアップになります。

ネットワークがあるときにプッシュします。リモートが一度も接続されていなかったことを、締め切り前夜になって知るのは避けてください。

ローカルでコンパイルし、リモートにバックアップする

たいていの週のループは、こうなります。オフラインで編集してコンパイルし、ネットワークがあるときにプッシュする。入力するためだけに、ブラウザーのライブセッションは要りません。

ツールに求めるものは、次のとおりです。

  • すべてのプロジェクトが最初から本物の Git リポジトリであること(git init の忘れがない)
  • コンパイル成功後と、入力が止まったあとの自動チェックポイント
  • ステージング、横並びの差分、破棄、ワンクリックでの復元が、エディターや PDF と同じアプリの中にあること
  • リモートとしての GitHub は任意で、履歴はすでにディスク上で機能していること
  • 並行して試す実験(リスクのある方法の書き直し、別バージョンの履歴書)のために、プロジェクト全体を完全な履歴ごとフォークでき、その間も提出用のコピーはそのまま残ること
  • AI による編集を有効にした場合は、先にチェックポイントが作られ、承認用の差分を通してのみ反映されること

Oleafly (新しいタブで開きます) は、そのように作られています。プレーンなフォルダー、本物の .git、動いたファイルの名前を記録する自動チェックポイント、編集できるワーキングツリーの差分を備えた「ソース管理」パネル、確認のあとの復元、ahead/behind 表示付きの GitHub への公開/プッシュ/プルが任意で使え、ライブラリには系譜付きのプロジェクトのフォークがあります。ターミナルでの git log がアプリと一致するのは、同じリポジトリだからです。AI のチェックポイントも、使った場合には、復元元と同じその履歴に入ります。

この一部は、注意深い習慣と、別の Git クライアントで近づけることができます。違いは、履歴が自分で設定して覚えておくものなのか、それとも SyncTeX やコンパイルと並んで、リサーチワークスペースが初日から前提としているものなのか、という点です。

Git が解決しないこと

Git は、PDF しか開かない PI からのコメントの代わりにはならず、誰のアブストラクトが正しいかを決めてもくれません。バイナリの図は今もマージが苦手なので、小さく保ち、再生成できるプロットを優先し、担当を早めに合意しておきます。

Git を拒む共著者には、レビュー用に PDF や DOCX を書き出して渡し、.tex を正本として保ちます。Word しか使わない共著者を参照してください。

最小限の実践

  1. 論文または学位論文ごとにリポジトリを 1 つ。キャリア全体を 1 つの巨大なリポジトリにしない。
  2. 初日から、ビルドのゴミ用の .gitignore を用意する。
  3. 複数人が編集するときは、章ごとの担当制にする。
  4. 読みやすいメッセージ付きの、マイルストーンのコミット。
  5. 作業が重要になる前に、非公開のリモートを接続しておく。
  6. 復元を一度、意図的に試しておく。最初の緊急事態が、最初の復元にならないように。

このリストを守れば、論文のための Git はほとんど背景に溶け込みます。締め切り前に欲しいのは、退屈なほどの信頼性であって、第二の趣味ではありません。

すべての投稿