Git для научных работ: что на самом деле работает с соавторами

Исследователи уже используют Git для написания кода. Документы очень похожи на код: простой текст, включает в себя сбор мусора. Поместить рукопись в репозиторий менее странно, чем это звучит, как только вы попробовали это один раз.

Не обращайте внимания на мусор

Разумный .gitignore для LaTeX:

*.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 опционально для удаленных пользователей; история уже работает на диске
• форкнуть целый проект с полной историей для параллельного эксперимента (рискованно) методы перезаписываются, альтернативное резюме), в то время как копия отправки остается на месте
• Изменения ИИ, если вы их включите, сначала проверьте точку и приземлитесь только через различия в одобрении

Oleafly создан для способ: простые папки, настоящий .git, автоматические контрольные точки, которые присваивают имена файлам, которые перемещено, панель управления версиями с редактируемыми различиями рабочего дерева, восстановление после подтверждение, опциональная публикация/отправка/вытягивание GitHub с опережением/позади, вилка проекта с родословная в библиотеке. Терминал git log соответствует приложению, потому что это тот же репозиторий. Контрольно-пропускной пункт ИИ, когда вы его используете, приземляется в том же месте. история, из которой вы восстанавливаете.

Вы можете аппроксимировать эти части с помощью тщательной привычки и отдельного Git. клиент. Разница в том, является ли история чем-то, что вы создаете и помните. или что-то, что предполагает исследовательская рабочая среда в первый день рядом с SyncTeX и скомпилировать.

Что Git не исправляет

Git не заменит комментарии ИП, который открывает только PDF-файлы, и не будет решить, чье изложение верно. Двоичные фигуры по-прежнему плохо сливаются, так что продолжайте они маленькие, предпочитают участки, которые можно восстановить, и договариваются о собственности как можно раньше.

Для соавторов, которые отказываются от Git, экспортируйте PDF или DOCX для проверки и сохраните .tex как источник истины. См. соавторы, говорящие только на Word.

Минимальная практика

1. Одно репо на одну статью или диссертацию, а не одно мегарепо за всю вашу карьеру.
2. .gitignore для мусора в первый день сборки.
3. Владение главой, когда ее редактируют более одного человека.
4. Milestone фиксируется с читаемыми сообщениями.
5. Личное удаленное подключение перед работой.
6. Восстановление проверялось один раз специально, поэтому первое ЧП не первое восстановить.

Если вы будете придерживаться этого списка, Git для документов в большинстве случаев исчезнет в тени. фон. Вам нужна скучная надежность перед дедлайном, а не второе хобби.