研究論文用の 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か月では役に立ちません。 「トランスに関する関連作業を書き直す」 十分です。 2 つのレイヤーが次のことに役立ちます。

1. マイルストーンに名前を付けます: セクションの下書き、提出、カメラの準備。
2. 安全チェックポイント: スナップショットを頻繁に撮影することで、午後の悪天候を回復できます。

コンパイルが成功した後、または入力をやめた後にエディターがチェックポイントを行う場合、 それらを唯一の歴史ではなくフロアとして扱います。本当のメッセージを書いてください セクションが承認されるか、草稿が共著者に渡されます。

プライベートリモコン

未公開の作品はプライベート GitHub または GitLab プロジェクトに属します。卒業と 研究室の移動により、人々はランダムなクラウド編集者アカウントにアクセスできなくなります。リモコン あなたが制御するのはバックアップです。

ネットワークがあるときに押します。締め切りの前夜まで待たないでください リモコンが接続されていないことがわかりました。

ローカルコンパイル、リモートバックアップ

ほとんどの週のループは次のようになります。オフラインで編集してコンパイルし、編集したときにプッシュします。 ネットワークを持っている。入力するだけであれば、ライブ ブラウザ セッションは必要ありません。

ツールに求めるもの:

• すべてのプロジェクトはすでに本物の Git リポジトリです (忘れられた「git init」はありません)
• コンパイルとアイドル編集が成功した後の自動チェックポイント
• 同じアプリ内でのステージング、並列差分、破棄、ワンクリック復元 エディターと PDF
• リモート用の GitHub はオプションです。履歴はすでにディスク上で動作しています
• 並行実験のために完全な履歴を含むプロジェクト全体をフォークします (危険です) メソッドの書き換え、代替履歴書）、提出されたコピーはそのままにされます
• AI 編集を有効にすると、最初にチェックポイントが作成され、通過した場合のみ着陸します。 承認の差分

Oleafly は次のように構築されています。 方法: プレーンなフォルダー、実際の .git、ファイルに名前を付ける自動チェックポイント 移動、編集可能な作業ツリーの差分を備えたソース コントロール パネル、後で復元 確認、オプションの GitHub のアヘッド/ビハインドによるパブリッシュ/プッシュ/プル、プロジェクト フォーク 図書館の系譜。ターミナル「git log」はアプリと一致します。 同じリポジトリ。 AI チェックポイントを使用すると、同じ場所に到達します。 復元元の履歴。

注意深い習慣と別個の Git を使用して、この一部を近似することができます。 クライアント。違いは、歴史が自分で設定して記憶するものであるかどうかです。 または、研究ワークスペースが初日から SyncTeX の次に想定しているものや、 コンパイルします。

Git で修正できないもの

Git は、PDF を開くだけの PI からのコメントを置き換えません。 誰の要約が正しいかを決定します。 2 進数のマージはまだうまくいかないので、 小規模で、再生可能な区画を好み、所有権については早めに合意します。

Git を拒否する共著者の場合は、レビュー用に PDF または DOCX をエクスポートし、.tex をそのままにしておいてください。 真実の源。参照 Word のみを話す共著者。

最低限の練習

1. キャリア全体で 1 つのメガリポジトリではなく、論文または論文ごとに 1 つのリポジトリを作成します。
2. 初日のビルドジャンクの「.gitignore」。
3. 複数人が編集する場合の章の所有権。
4. 判読可能なメッセージを含むマイルストーンコミット。
5. 仕事が重要になる前にプライベートリモートが接続されます。
6. 復元は意図的に一度テストされているため、最初の緊急事態は最初ではありません。 復元します。

このリストに従うと、論文用の Git はほとんどの場合に消えてしまいます。 背景。締め切り前に必要なのは、第二の趣味ではなく、退屈な信頼性です。