GitHub 사용 매뉴얼

Branch 구조 (Layer 구조)

[담당한 layer] / [데이터셋 버전] / [본인 이름]

예시:

model/v1/sumin/
data/v2/minho/ 

• 버전 명은 v[숫자] 형식으로 진행합니다.

---

작업 규칙

1. 파일 수정 시

• .py 파일 상단에 반드시 명시

# 수정자: 이름
# 수정 날짜: YYYY-MM-DD
# 수정 내용: 어떤 변경인지 간단히 설명

---

2. 수정 내용 정리

• 수정한 전체 내용은 별도로 상단에 정리
• 상태 표시 사용

[ING] 진행 중
[TODO] 할 일
[DONE] 완료

예시:

[DONE] 데이터 전처리 개선
[ING] 모델 구조 변경 (ing)
[TODO] 테스트 코드 작성 (todo)

---

3. 코드 수정 기준

• 코드 수정 시 "목적"을 명확히 작성
• 단순 수정 ❌ → 이유 포함한 수정 ✅

예시:

❌ 코드 수정 시 이전 내용 절대 지우지 말기 ‼️
✅ # 주석 처리 후, 몇 버전이었는지 명시 (ex. #[v2] - 김예슬)
✅ 모델 성능 개선을 위한 loss 함수 변경 << 상단에 주석으로 작성하기

• 버전 명은 v[숫자] 형식으로 진행합니다.

---

4. 기존 코드 수정 시 히스토리 관리 ‼️

절대로 기존 코드를 삭제하지 말 것! 수정 전 코드는 반드시 주석 처리 후 버전과 작성자를 명시하여 남겨둬야 합니다.

규칙

• 기존 코드를 수정할 경우, 이전 코드를 지우지 않고 주석 처리
• 주석 옆에 #[vN] - 이름 형식으로 버전과 담당자를 반드시 표기
• 새 코드는 바로 아래 또는 옆에 작성

예시

# [v1] - 김수민: 기존 loss 함수
# criterion = nn.MSELoss()

# [v2] - 이민호: 성능 개선을 위해 CrossEntropyLoss로 변경
criterion = nn.CrossEntropyLoss()

# [v1] - 박지수: 기존 전처리 방식
# df = df.dropna()

# [v2] - 최예린: 결측값을 평균으로 대체하도록 변경 (dropna 시 데이터 손실 문제)
df = df.fillna(df.mean())

핵심 정리

상황	해야 할 것
코드 수정 시	기존 코드 주석 처리 + #[vN] - 이름 태그
새 코드 작성 시	변경 이유를 주석으로 명시
이전 코드 삭제	❌ 절대 금지

---

커밋 규칙

기본 구조

[타입] 작업 내용

타입 종류

• feat: 새로운 기능
• bug: 버그 수정
• refactor: 코드 리팩토링
• docs: 문서 수정

---

예시

feat: 데이터 전처리 로직 추가
fix: 모델 학습 중 NaN 발생 문제 해결
refactor: inference 코드 구조 개선

• 커밋 내용은 자유

---

담당자 표시

• 작업 파일 / 기능마다 담당자 명시 꼭 ‼️
• .py 파일 상단에 주석으로 명시

- 담당자: 홍길동

---

협업 핵심 규칙 요약

• 수정 내용은 반드시 기록
• 커밋 메시지는 목적 중심으로 작성
• 작업 상태는 항상 공유
• 디렉토리는 역할 기준으로 분리
• 기존 코드는 절대 삭제 금지, 주석 처리 후 버전 히스토리 남기기 ‼️