연구 코드에 Git을 사용하는 방법

Git으로 분석 코드의 변경 이력을 관리하고 논문의 표나 그림을 만든 정확한 커밋을 기록합니다.

언어한국어

Git으로 무엇을 관리할까요?

Git은 선택한 파일의 특정 시점을 스냅샷으로 기록합니다. README, 분석 스크립트, 데이터 사전부터 추적해 보세요. 이 시리즈의 작은 모의 CSV도 포함할 수 있습니다. 실제 연구 데이터는 저장하거나 공유하기 전에 사용 권한과 개인정보 보호 요건을 확인하세요. 접근이 제한된 데이터나 대용량 입력은 허가받은 동료가 어떻게 구할 수 있는지 문서에 적어 둘 수 있습니다.

다시 만들 수 있는 로컬 환경, 생성 결과와 임시 파일은 .gitignore에 넣습니다. 스테이징하기 전에 git status로 확인하세요. 무시 규칙은 이미 추적 중인 파일이나 과거 커밋에서 민감한 데이터를 제거하지 않습니다.

.venv/
__pycache__/
results/

첫 번째 스냅샷 만들기

학습 시간 예제 프로젝트를 내려받아 압축을 풀고, 터미널에서 추출된 study-sessions/ 폴더로 이동하세요. 이 예제에는 README, 데이터 사전, 분석 스크립트와 .gitignore가 들어 있습니다. 네 행은 실제 연구 결과가 아닌 모의 데이터입니다.

git init
git status --short
git add README.md .gitignore data/sessions.csv data/data-dictionary.md analysis/analyze.py
git diff --cached
git commit -m "Add study-session data and mean-duration analysis"

git add는 다음 스냅샷에 넣을 변경 사항을 선택하고, git diff --cached는 선택된 내용을 보여 주며, git commit은 이를 기록합니다. 첫 커밋이라면 Git에서 이름과 이메일 설정을 요청할 수 있습니다. 로컬 커밋은 직접 푸시하기 전까지 내 컴퓨터에만 있습니다.

논문 결과에 사용한 커밋 기록하기

보고서에 넣을 표를 만들 때 전체 커밋 ID와 입력 데이터의 버전을 함께 적어 두세요. 실제 실행한 변경 사항이 그 커밋에 포함되어야 의미가 있습니다. 커밋하지 않은 수정이 있는지 확인하고 기록할 버전에서 다시 실행하세요.

git status --short
git rev-parse HEAD
git log --oneline -5

git rev-parse HEAD가 출력하는 전체 ID를 실행 기록이나 논문 부록에 남기면 나중에 같은 코드 버전을 찾을 수 있습니다. 예를 들어 조용한 환경의 평균 25.0분을 만든 코드 옆에 기록할 수 있습니다. 나중에 정확한 스크립트를 확인하려면 아래의 <commit-id>를 저장한 ID로 바꿔 실행하세요.

git show <commit-id>:analysis/analyze.py

변경 사항 하나를 검토하고 기록하기

README에 예제 데이터가 모의 데이터인 이유를 한 문장 추가하세요. 그 파일만 스테이징하고 변경 내용을 살펴본 뒤, 변경의 의미가 드러나는 메시지로 커밋해 보세요.

예시 답안 보기
git add README.md
git diff --cached
git commit -m "Explain the origin of the synthetic data"
git log -2 --oneline

이전 장에서 데이터와 README를 정리하는 방법도 확인할 수 있습니다.

참고 자료

이 글은 The Turing Way Community가 CC BY 4.0로 공개한 내용을 참고·각색했습니다. Miss Formula는 학습 순서를 재구성하고 설명, 예제 및 연습 문제를 추가했습니다.