연구 논문을 위한 Git: 공저자와 함께할 때 실제로 통하는 방법

무시 규칙, 장별 담당, 커밋 메시지, 비공개 원격 저장소, 그리고 진짜 Git과 포크와 AI 체크포인트를 갖춘 연구 작업 공간이 Git을 또 하나의 일로 만들지 않으면서 논문을 복구 가능한 상태로 지켜 주는 방법을 다룹니다.

연구자는 이미 코드에 Git을 씁니다. 논문은 코드와 꽤 닮았습니다. 평문 텍스트, include 파일, 빌드 부산물이 있으니까요. 원고를 저장소에 넣는 일은 한 번만 해 보면 들리는 것만큼 낯설지 않습니다.

불필요한 파일은 무시하세요

LaTeX에 알맞은 .gitignore는 다음과 같습니다.

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

.tex, .bib, 다시 만들 수 없는 그림, 그리고 대학이 요구한다면 클래스 파일을 커밋하세요. 저널이 아카이브에 바이너리를 요구하는 경우가 아니라면 모든 PDF를 커밋하지는 마세요.

편집기가 Git을 대신 시작해 준다면 빌드 캐시와 PDF 중간 파일이 무시되는지 확인하세요. aux 파일 때문에 생기는 내용 없는 “잡음” 커밋이 줄줄이 쌓이면 로그는 쓸모가 없어집니다. 로그를 읽지 않게 되고, 그러면 무언가 망가졌을 때 기록이 도움이 되지 못합니다.

줄이 아니라 파일 단위로 맡으세요

두 사람이 같은 문단을 고치면 병합이 고통스럽습니다. 장이나 절 단위로 담당을 나누는 편이 좋습니다. 리뷰가 실제로 도움이 될 만큼 그룹이 크다면 풀 리퀘스트를 쓰세요.

하나의 버퍼에서 여러 사람이 실시간으로 입력하는 것은 다른 도구(브라우저 기반 LaTeX 편집기)의 영역입니다. Git 협업은 더 느리고 더 명시적입니다. 브랜치를 만들고, 푸시하고, 리뷰합니다. 기록이 남아야 할 때는 잘 맞습니다. 오늘 오후에 세 사람이 초록을 함께 입력해야 한다면 다른 도구를 고르세요.

나중의 내가 읽을 수 있는 커밋 메시지

“수정함”은 석 달만 지나도 쓸모가 없습니다. “트랜스포머 관련 연구 절 다시 쓰기” 정도면 충분합니다. 두 층위로 나누면 도움이 됩니다.

  1. 이름을 붙이는 이정표: 절별 초안, 투고, 최종본(camera-ready).
  2. 안전용 체크포인트: 자주 찍는 스냅샷으로, 망친 오후를 되돌릴 수 있게 합니다.

편집기가 컴파일에 성공한 뒤나 입력을 멈춘 뒤에 체크포인트를 만든다면, 그것은 최소한의 바닥선으로 보고 유일한 기록으로 삼지 마세요. 한 절이 완성되거나 초안을 공저자에게 보낼 때는 제대로 된 메시지를 쓰세요.

비공개 원격 저장소

미발표 작업은 비공개 GitHub나 GitLab 프로젝트에 두세요. 졸업하거나 연구실을 옮길 때는 여기저기 흩어진 클라우드 편집기 계정에 접근하지 못하게 되는 경우가 많습니다. 내가 관리하는 원격 저장소가 백업입니다.

네트워크가 될 때 푸시하세요. 마감 전날 밤이 되어서야 원격 저장소가 연결된 적이 없다는 걸 알게 되는 일이 없도록 하세요.

로컬 컴파일, 원격 백업

대부분의 주에는 이런 흐름입니다. 오프라인에서 편집하고 컴파일하고, 네트워크가 될 때 푸시합니다. 글을 입력하기 위해 브라우저 세션을 계속 열어 둘 필요는 없습니다.

도구에 바라는 것은 다음과 같습니다.

  • 모든 프로젝트가 처음부터 진짜 Git 저장소일 것(깜빡한 git init 없이)
  • 컴파일에 성공한 뒤와 편집이 잠시 멈춘 뒤의 자동 체크포인트
  • 스테이지, 나란히 보는 diff, 변경 취소, 원클릭 복원을 편집기와 PDF가 있는 같은 앱 안에서 쓸 수 있을 것
  • 원격 저장소용 GitHub는 선택 사항이고, 이력은 이미 디스크에서 동작할 것
  • 위험한 연구 방법 절 개작이나 다른 버전의 이력서 같은 병렬 실험을 위해 전체 이력과 함께 프로젝트를 통째로 포크하고, 제출용 사본은 그대로 둘 수 있을 것
  • AI 편집은, 켠 경우에 한해, 먼저 체크포인트를 만들고 승인 diff를 거쳐서만 반영될 것

Oleafly (새 탭에서 열림)는 이 방식으로 만들어졌습니다. 평범한 폴더, 진짜 .git, 바뀐 파일의 이름을 적어 주는 자동 체크포인트, 편집 가능한 작업 트리 diff를 갖춘 소스 관리 패널, 확인 후 복원, 선택 사항인 GitHub 게시·푸시·풀과 앞선·뒤처진 커밋 수 표시, 라이브러리에서 계보가 보이는 프로젝트 포크가 있습니다. 터미널의 git log는 앱과 같은 저장소를 보기 때문에 결과가 일치합니다. AI 체크포인트도, 사용했다면, 복원에 쓰는 바로 그 이력에 들어갑니다.

꼼꼼한 습관과 별도의 Git 클라이언트로 이 가운데 일부는 비슷하게 흉내 낼 수 있습니다. 차이는 이력이 직접 설정하고 기억해 둬야 하는 것인지, 아니면 연구 작업 공간이 SyncTeX와 컴파일 옆에서 첫날부터 당연하게 갖추고 있는 것인지에 있습니다.

Git이 해결하지 못하는 것

Git은 PDF만 여는 책임연구자(PI)의 코멘트를 대신해 주지 못하고, 누구의 초록이 맞는지 정해 주지도 않습니다. 바이너리 그림은 여전히 병합이 잘 되지 않으니 크기를 작게 유지하고, 다시 만들 수 있는 플롯을 우선하며, 담당을 일찍 합의하세요.

Git을 거부하는 공저자에게는 검토용으로 PDF나 DOCX를 내보내고, .tex를 원본으로 유지하세요. Word만 쓰는 공저자를 참고하세요.

최소한의 실천 수칙

  1. 논문 한 편이나 학위논문 하나에 저장소 하나로 하세요. 평생의 연구를 담는 거대한 저장소 하나는 안 됩니다.
  2. 첫날부터 빌드 부산물을 위한 .gitignore를 둡니다.
  3. 두 명 이상이 편집할 때는 장별 담당을 정합니다.
  4. 읽을 수 있는 메시지를 단 이정표 커밋을 남깁니다.
  5. 작업이 중요해지기 전에 비공개 원격 저장소를 연결합니다.
  6. 복원을 일부러 한 번 시험해 봐서, 첫 비상 상황이 첫 복원이 되지 않게 합니다.

이 목록만 지키면 논문용 Git은 대부분 배경으로 사라집니다. 마감 전에 필요한 것은 지루할 만큼 믿을 수 있는 안정성이지, 두 번째 취미가 아닙니다.

모든 게시물