用於研究論文的 Git:與合著者實際有效的方法

忽略規則、章節所有權、提交訊息、私人遙控器,以及具有真正 Git、分叉和 AI 檢查點的研究工作區如何在不讓 Git 成為第二份工作的情況下保持論文可恢復。

研究人員已經使用 Git 來編寫程式碼。論文看起來很像程式碼:純文本, 包括,建構垃圾。將手稿放入儲存庫並不那麼奇怪 一旦你嘗試過一次就會發出聲音。

忽略垃圾

LaTeX 的一個合理的 .gitignore

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

提交.tex.bib,數字你無法重新生成,並且類別文件如果 大學需要它。除非期刊想要,否則跳過提交每個 PDF 存檔中的二進位。

如果您的編輯器為您啟動 Git,請檢查建置快取和 PDF 中間體被忽略。來自 aux 檔案的空「雜訊」串流提交 使日誌毫無價值。你停止閱讀它,那麼歷史就無濟於事了 當東西壞了的時候你。

自己的文件,而不是行

兩個人同段就是合併痛苦。喜歡章節或章節 所有權。當群組足夠大以進行審查時使用拉取請求 實際上有幫助。

在一個緩衝區中進行即時多用戶輸入是一種不同的工具(瀏覽器 LaTeX 編輯)。 Git 協作更慢、更明確:分支、推播、審查。 当您需要书面记录时,这很有效。當三個人必須輸入 今天下午一起抽象,选别的东西。

提交將來您可以閱讀的訊息

「修東西」三個月後就沒用了。 《重寫變壓器相關工作》 就足夠了。兩層幫助:

  1. 您指定的里程碑:部分草稿、提交、相機準備就緒。
  2. 安全檢查點:頻繁快照,這樣糟糕的下午就可以逆轉。

如果您的編輯器在成功編譯後或停止輸入後設定檢查點, 將這些視為地板,而不是唯一的歷史。當出現以下情況時,寫一條真實的訊息: 部分土地或草稿歸共同作者所有。

私人遙控器

未出版的作品屬於私有 GitHub 或 GitLab 專案。畢業和 實驗室遷移是指人們無法存取隨機雲端編輯器帳戶。一個遙控器 你控制的是備份。

有網路時推送。不要等到截止日期前一天晚上才 發現遙控器從未連接過。

本機編譯、遠端備份

大多数星期循环看起来像这样:离线编辑和编译,当你 有網路。您不需要即時瀏覽器會話來打字。

您希望從工具中獲得什麼:

  • 每個專案都已經是一個真正的 Git 儲存庫(不要忘記 git init
  • 成功編譯和空閒編輯後的自動檢查點
  • 在同一個應用程式中進行階段、並排比較、丟棄和一鍵恢復 編輯器和 PDF
  • GitHub 可選用於遙控器;歷史記錄已在磁碟上運行
  • 分叉一個具有完整歷史記錄的整個專案以進行平行實驗(有風險 方法重寫,備用履歷),同時提交副本不變
  • AI編輯,如果啟用它們,首先檢查點並僅通過 批准差異

Oleafly 的建構是 方式:普通資料夾,真正的“.git”,自動檢查點,命名文件 已移動,具有可編輯工作樹差異的源代碼控制面板,之後恢復 確認,可選的 GitHub 發布/推送/拉取(前/後),專案分叉 圖書館裡的血統。終端 git log 與應用程式匹配,因為它是 相同的儲存庫。當你使用人工智慧檢查點時,它會落在相同的位置 您從中恢復的歷史記錄。

您可以透過仔細的習慣和單獨的 Git 來近似實現這一點 客戶。差別在於歷史是否是你設定並記住的東西, 或是研究工作區在第一天假設的 SyncTeX 旁邊的東西 編譯。

Git 無法解決的問題

Git 不會取代只開啟 PDF 的 PI 的評論,也不會 決定誰的摘要是正確的。二進制數字仍然合併得很糟糕,所以保留 它們很小,更喜歡可以再生的地塊,並儘早就所有權達成一致。

對於拒絕 Git 的合著者,請匯出 PDF 或 DOCX 以供審閱,並將「.tex」保留為 真相的來源。參見 只講 Word 的合著者

最低限度的練習

  1. 每篇論文或論文一個 repo,而不是整個職業生涯的一個大型 repo。
  2. .gitignore 用於第一天建構垃圾。 3.多人編輯時的章節所有權。
  3. 具有可讀訊息的里程碑提交。 5.在工作之前連接私人遠端。
  4. 故意恢復測試一次,因此第一個緊急狀況不是第一個 恢復。

如果你堅持這個列表,Git 論文大部分都會消失在 背景。你想要的是在截止日期之前無聊的可靠性,而不是第二個愛好。

所有貼文