논문을 GitHub에 올리기
초기화, 보조 파일 무시, 비공개 저장소, 공저자 병합을 수월하게 하는 습관.
논문을 GitHub에 올리기
LaTeX 원고는 일반 텍스트라서 Git과 아주 잘 맞습니다. 초안마다 되돌아갈 수 있는 커밋이 되고, 모든 변경이 줄 단위 차이(diff)로 보이며, GitHub는 외부 사본을 두고 공저자가 현재 상태를 가져갈 수 있는 방법도 제공합니다. 어느 것도 고급 Git 지식을 요구하지 않습니다. 논문에는 명령 다섯 개 정도를 꾸준히 쓰면 충분합니다.
처음 설정
git init# add a .gitignore for *.aux *.log *.out *.toc *.synctex.gzgit 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를 빼고 로컬에서 다시 빌드하지만, 제출한 버전을 고정하는 방법으로 태그된 릴리스에 PDF를 첨부하는 것은 합리적입니다. 연구가 공개되기 전까지는 저장소를 비공개로 두세요. 미발표 원고는 색인되게 둘 것이 아닙니다.
공저자와의 협업을 편하게 하는 습관
각 커밋은 논리적 변경 하나로 만드세요. “3절 서론 수정”이나 “절제 실험 표 추가” 같은 것입니다. 그러면 기록이 논문의 이야기처럼 읽히고, 잘못된 편집은 부수적인 피해 없이 되돌릴 수 있습니다. 작성을 시작하기 전에 pull하고 멈출 때 push하세요. 병합 충돌은 브랜치가 떨어져 있는 시간에 비례해 커집니다. 공저자가 가져간 공유 브랜치는 절대 강제 push하지 마세요. 그들의 발밑에서 기록을 다시 쓰는 일입니다. 큰 바이너리(데이터셋, 동영상)는 논문 저장소에 넣지 마세요. 아카이브로 링크하거나 별도의 데이터 저장소를 쓰세요. Git은 모든 바이너리의 모든 버전을 영원히 저장합니다.
LaTeX에 특화된 습관이 하나 있습니다. 소스 한 줄에 문장 하나씩 쓰면 한 단어를 고쳤을 때 문단 전체가 다시 흐르는 대신 한 줄 변경으로 보이므로 diff가 훨씬 읽기 쉬워집니다.
Oleafly와 함께 쓰기
모든 Oleafly 프로젝트는 디스크의 평범한 폴더이므로 이 명령들을 그대로 쓸 수 있습니다. Oleafly는 소스가 바뀐 성공 빌드 중 조건에 맞는 것을 Git과 별도로 저장된 체크포인트에 보관합니다. 의도적인 커밋은 소스 관리에서 만들고, 공동 작업자와 push 또는 pull 하세요. Git 기록을 참고하세요. 이를 토대로 한 공동 작업 방식, 즉 패치 교환과 장 담당 지정을 알고 싶다면 라이브 커서 없이 공저하기를 보세요.