Git для научных статей: что действительно работает с соавторами
Правила игнорирования, закрепление глав за людьми, сообщения коммитов, приватные удалённые репозитории и то, как рабочее пространство для исследований с настоящим Git, ответвлениями и контрольными точками для правок ИИ делает статьи восстановимыми, не превращая Git во вторую работу.
Исследователи уже пользуются Git для кода. Статьи очень похожи на код: обычный текст, подключаемые файлы, мусор от сборки. Положить рукопись в репозиторий не так странно, как кажется, стоит попробовать один раз.
Игнорируйте мусор
Разумный .gitignore для LaTeX:
*.aux*.log*.out*.toc*.synctex.gz*.bbl*.blg*.fdb_latexmk*.flsКоммитьте .tex, .bib, рисунки, которые нельзя сгенерировать заново, и файл класса, если его требует университет. Не коммитьте каждый PDF, если только журнал не хочет видеть бинарный файл в архиве.
Если ваш редактор сам запускает Git за вас, проверьте, что кэши сборки и промежуточные файлы PDF игнорируются. Поток пустых «шумовых» коммитов из aux-файлов обесценивает журнал коммитов. Вы перестаёте его читать, и тогда история не может помочь вам, когда что-то ломается.
Закрепляйте за людьми файлы, а не строки
Двое в одном абзаце — это боль при слиянии. Лучше закреплять за людьми главы или разделы. Используйте пулл-реквесты, когда группа достаточно велика и ревью действительно помогает.
Одновременный набор текста несколькими людьми в одном буфере — это другой инструмент (браузерные редакторы LaTeX). Совместная работа через Git медленнее и явнее: ветка, push, ревью. Это хорошо работает, когда нужен документальный след. Когда трое должны сегодня днём вместе набрать аннотацию, выберите что-нибудь другое.
Сообщения коммитов, которые вы сможете прочитать потом
«Поправил всякое» через три месяца бесполезно. «Переписан обзор связанных работ по трансформерам» — достаточно. Помогают два слоя:
- Вехи, которым вы даёте имя: черновики разделов, подача, финальная версия.
- Страховочные контрольные точки: частые снимки, чтобы неудачный вечер можно было откатить.
Если ваш редактор делает контрольные точки после успешной компиляции или после того, как вы перестали печатать, считайте их нижней планкой, а не единственной историей. Пишите настоящее сообщение, когда раздел готов или черновик уходит соавторам.
Приватные удалённые репозитории
Неопубликованная работа должна лежать в приватных проектах GitHub или GitLab. Выпуск из университета и переходы между лабораториями — моменты, когда люди теряют доступ к случайным аккаунтам облачных редакторов. Удалённый репозиторий, который вы контролируете, и есть резервная копия.
Делайте push, когда есть сеть. Не ждите ночи перед дедлайном, чтобы обнаружить, что удалённый репозиторий так и не подключён.
Компиляция локально, резервная копия удалённо
Большинство недель цикл выглядит так: вы редактируете и компилируете офлайн, делаете push, когда есть сеть. Чтобы просто набирать текст, открытая сессия в браузере не нужна.
Чего стоит ждать от инструментов:
- каждый проект уже является настоящим репозиторием Git (никаких забытых
git init) - автоматические контрольные точки после успешных компиляций и пауз в редактировании
- добавление в индекс, сравнение изменений рядом, отмена изменений и восстановление в один клик в том же приложении, где редактор и PDF
- GitHub необязателен для удалённых репозиториев; история уже работает на диске
- ответвление всего проекта с полной историей для параллельного эксперимента (рискованная переработка методов, альтернативная версия резюме), пока копия для подачи остаётся на месте
- правки ИИ, если вы их включили, сначала создают контрольную точку и попадают в проект только после одобрения через сравнение изменений
Oleafly (откроется в новой вкладке) устроен именно так: обычные папки, настоящий .git, автоматические контрольные точки, в названии которых указаны изменившиеся файлы, панель «Контроль версий» с редактируемыми сравнениями изменений рабочего дерева, восстановление после подтверждения, необязательные публикация, push и pull в GitHub с отображением «впереди/позади», ответвление проекта с родословной в библиотеке. git log в терминале совпадает с тем, что показывает приложение, потому что это тот же репозиторий. Контрольная точка перед правками ИИ, если вы ими пользуетесь, попадает в ту же историю, из которой вы восстанавливаетесь.
Часть этого можно воспроизвести аккуратной привычкой и отдельным клиентом Git. Разница в том, настраиваете ли вы историю и помните о ней сами или же рабочее пространство для исследований предполагает её с первого дня, рядом с SyncTeX и компиляцией.
Что Git не исправит
Git не заменит комментарии научного руководителя, который открывает только PDF, и не решит, чья аннотация верна. Бинарные рисунки по-прежнему плохо сливаются, поэтому держите их небольшими, предпочитайте графики, которые можно сгенерировать заново, и заранее договаривайтесь о том, кому что принадлежит.
Для соавторов, которые отказываются от Git, экспортируйте PDF или DOCX для проверки, а .tex оставьте источником истины. См.
соавторы, которые признают только Word.
Минимальная практика
- Один репозиторий на статью или диссертацию, а не один мегарепозиторий на всю карьеру.
.gitignoreдля мусора сборки с первого дня.- Закрепление глав за людьми, когда правят несколько человек.
- Коммиты-вехи с читаемыми сообщениями.
- Приватный удалённый репозиторий подключён до того, как работа станет важной.
- Восстановление один раз проверено специально, чтобы первая авария не стала первым восстановлением.
Если придерживаться этого списка, Git для статей в основном уходит на задний план. Перед дедлайном вам нужна скучная надёжность, а не второе хобби.