Положите статью на GitHub

Инициализация, игнорирование служебных файлов, закрытый репозиторий и привычки, которые сохраняют слияния с соавторами в здравом уме.

Положите статью на GitHub

Рукопись на LaTeX — это обычный текст, поэтому она идеально подходит для Git. Каждый черновик становится коммитом, к которому можно вернуться, каждое изменение видно как построчная разница, а GitHub даёт внешнюю копию и способ для соавторов получить актуальное состояние. Для всего этого не нужны продвинутые навыки Git. Статье хватит примерно пяти команд, если применять их последовательно.

Первоначальная настройка

Окно терминала
git init
# add a .gitignore for *.aux *.log *.out *.toc *.synctex.gz
git add main.tex refs.bib figures/
git commit -m "Initial manuscript"
gh repo create my-paper --private --source=. --push

Выполните это один раз в папке проекта. Шаг с .gitignore важнее, чем кажется. Каждая компиляция заново создаёт файлы .aux, .log, .out, .toc и .synctex.gz, и если их закоммитить, ваши настоящие изменения утонут в машинном шуме, а между соавторами начнутся бессмысленные конфликты слияния. Отслеживайте только то, что пишете сами: исходники .tex, базу .bib, рисунки и файлы классов или стилей, которые дала площадка. PDF тоже продукт сборки. Большинство команд не включают его в репозиторий и пересобирают локально, хотя прикрепить PDF к помеченному релизу — разумный способ зафиксировать поданную версию. Держите репозиторий закрытым, пока работа не опубликована. Неопубликованная рукопись не должна индексироваться.

Привычки, которые сохраняют рассудок соавторов

Делайте каждый коммит одним логическим изменением, например «revise section 3 intro» или «add ablation table». Тогда история читается как рассказ о статье, а неудачную правку можно откатить без побочных потерь. Делайте pull перед началом сеанса письма и push, когда заканчиваете. Конфликты слияния растут вместе со временем, которое ветки проводят порознь. Никогда не делайте force-push в общую ветку, после того как соавторы её получили: это переписывает историю у них под ногами. Не храните в репозитории статьи крупные бинарные артефакты (наборы данных, видео). Дайте ссылку на архив или заведите отдельный репозиторий для данных. Git навсегда хранит каждую версию каждого бинарного файла.

Одна привычка, свойственная именно LaTeX: если писать по одному предложению на строку исходника, различия читаются несравненно легче, потому что правка одного слова видна как изменение одной строки, а не как переформатированный абзац.

Как это сочетается с Oleafly

Каждый проект Oleafly — обычная папка на диске, поэтому эти команды работают с ним без изменений. Подходящие успешные сборки с изменённым исходным кодом Oleafly хранит в разделе Сохранённые контрольные точки, отдельно от Git. Делайте осознанные коммиты в разделе «Контроль версий», затем отправляйте и получайте изменения вместе с соавторами. См. История Git. О шаблонах совместной работы, построенных на этом, включая обмен патчами и распределение глав, см. Работа с соавтором без общего курсора.

Вернуться к Локальная студия