研究論文的 Git:和共同作者合作時真正行得通的做法
忽略規則、章節歸屬、提交訊息、私有遠端,以及具備真正 Git、分支與 AI 檢查點的研究工作區,如何讓論文隨時可以復原,卻不讓 Git 變成第二份工作。
研究人員本來就在用 Git 管理程式碼。論文看起來很像程式碼:純文字、引入檔、建置產生的雜物。一旦親自試過,把稿件放進儲存庫就沒有聽起來那麼奇怪。
忽略雜物
LaTeX 合理的 .gitignore:
*.aux*.log*.out*.toc*.synctex.gz*.bbl*.blg*.fdb_latexmk*.fls提交 .tex、.bib、無法重新產生的圖,以及學校要求時的類別檔。除非期刊要求在歸檔裡放二進位檔,否則不要提交每一份 PDF。
如果你的編輯器替你啟動 Git,請確認建置快取與 PDF 中間檔都被忽略了。來自 aux 檔案的一連串空洞的「雜訊」提交,會讓記錄變得毫無價值。你會不再去看它,然後等到出事時,歷史就幫不上忙了。
以檔案為歸屬,而不是以行為歸屬
兩個人在同一個段落裡編輯,就是合併的痛苦。優先採用章節或小節歸屬。當團隊大到審閱確實有幫助時,才使用 pull request。
在同一個緩衝區裡即時多人打字,是另一種工具(瀏覽器 LaTeX 編輯器)。Git 協作比較慢,也比較明確:建立分支、推送、審閱。需要留下書面軌跡時,這很管用。如果三個人今天下午必須一起寫摘要,請選別的工具。
未來的你讀得懂的提交訊息
「修了一些東西」三個月後毫無用處。「改寫關於 transformer 的相關研究」就夠了。兩個層次會有幫助:
- 你命名的里程碑:各節草稿、投稿、最終定稿。
- 安全檢查點:頻繁的快照,讓糟糕的一個下午可以復原。
如果你的編輯器在編譯成功之後,或在你停止打字之後建立檢查點,請把這些當成底線,而不是唯一的歷史。當一個章節完成,或草稿要寄給共同作者時,寫一則像樣的訊息。
私有遠端
未發表的作品應放在私有的 GitHub 或 GitLab 專案裡。畢業與實驗室異動,正是人們失去各種雲端編輯器帳號存取權的時候。你自己掌控的遠端就是備份。
有網路時就推送。不要等到截止前一晚,才發現遠端從來沒有連上。
本機編譯,遠端備份
大多數週,工作循環長這樣:離線編輯與編譯,有網路時推送。你不需要為了打字而保持一個即時的瀏覽器工作階段。
你希望工具提供的:
- 每個專案本來就是真正的 Git 儲存庫(不會有忘記執行的
git init) - 編譯成功與閒置編輯之後的自動檢查點
- 暫存、並排差異、捨棄與一鍵還原,和編輯器、PDF 在同一個應用程式裡
- GitHub 作為遠端是選用的;歷史在硬碟上本來就能運作
- 把整個專案連同完整歷史分支出去,做平行實驗(冒險的方法章節重寫、另一份履歷),同時讓送件副本維持原狀
- AI 編輯如果啟用,會先建立檢查點,並且只透過需核准的差異落地
Oleafly (在新分頁開啟) 就是這樣打造的:純資料夾、真正的 .git、會標出哪些檔案有變動的自動檢查點、具備可編輯工作樹差異的原始檔控制面板、確認後還原、附領先/落後狀態的選用 GitHub 發布/推送/拉取,以及專案庫中帶有族譜的專案分支。終端機裡的 git log 與應用程式一致,因為它就是同一個儲存庫。使用 AI 時建立的檢查點,也會落在你還原所用的同一份歷史裡。
你可以靠謹慎的習慣和獨立的 Git 用戶端,近似地做到其中幾項。差別在於,歷史是你得自己設定並記得的東西,還是研究工作區在第一天就預設存在、與 SyncTeX 和編譯並排的東西。
Git 修不了的事
Git 不會取代只打開 PDF 的計畫主持人給的意見,也不會決定誰的摘要才是對的。二進位的圖仍然合併得很糟,所以要保持小檔案、優先使用可重新產生的繪圖,並及早約定歸屬。
對於拒絕使用 Git 的共同作者,匯出 PDF 或 DOCX 供審閱,並把 .tex 保留為唯一可信的來源。請見只講 Word 的共同作者。
最精簡的做法
- 每篇論文或學位論文一個儲存庫,而不是整個職涯共用一個巨型儲存庫。
- 第一天就為建置雜物設定
.gitignore。 - 當不只一個人編輯時,採用章節歸屬。
- 里程碑提交,訊息要讀得懂。
- 在工作變得重要之前,就連上私有遠端。
- 刻意測試一次還原,這樣第一次緊急狀況就不會是第一次還原。
如果你堅持做到這份清單,論文的 Git 大多會消失在背景裡。你要的是死線前無聊的可靠,而不是第二個嗜好。