研究论文的 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 的 PI 给出的批注,也无法决定谁写的摘要才是对的。二进制的图片仍然很难合并,所以要保持它们体积小,优先使用可以重新生成的图,并且尽早约定归属。
对拒绝使用 Git 的合作者,导出 PDF 或 DOCX 供他们审阅,并以 .tex 为准。参见只会用 Word 的合作者。
一套最简实践
- 每篇论文或每份毕业论文一个仓库,而不是整个学术生涯共用一个巨型仓库。
- 第一天就用
.gitignore忽略构建垃圾文件。 - 多人编辑时按章分工。
- 里程碑提交,附上可读的提交信息。
- 在工作变得重要之前就连好私有远程仓库。
- 有意识地测试一次恢复,这样第一次紧急情况就不会是你第一次恢复。
如果你坚持照这份清单做,论文的 Git 管理大多会退到幕后。你在截止日期前想要的是平淡无奇的可靠,而不是第二个爱好。