작업 마무리 (기능 구현 → 문서 → 커밋)

필수 원칙

• 세션에서 작업한 내역과 관계없이, git에 남아있는 모든 변경사항(unstaged, staged)을 빠짐없이 커밋하여 working tree를 clean 상태로 만든다.
• 세션 중 직접 변경하지 않은 파일이라도 변경이 감지되면 분석 후 적절히 분류하여 커밋한다.
• 커밋 전, 세션에서 추가/수정한 코드 파일에 대해 npx prettier --write <files>를 실행하여 포맷팅을 적용한다. 포맷팅으로 인한 변경은 해당 기능 커밋에 포함한다.

1단계: 변경사항 분석

git status
git diff --stat
git diff

변경된 파일들을 분석하여:

• 어떤 기능이 추가/수정되었는지 파악
• 관련 문서가 있는지 확인

2단계: 문서 업데이트

변경사항이 다음에 해당하면 문서 업데이트:

문서 작성 규칙

• 설계 문서: docs/design/YYYYMMDD-<topic>.md
• 작업 일지: docs/logs/YYYYMMDD-<title>.md
• 기존 문서 수정 시 수정일 명시

3단계: 커밋

커밋 규칙

Conventional Commits 형식:

<타입>: <제목> (<스코프>)

<본문>

<꼬리말>

타입

제목 규칙

• 명령형 현재 시제 사용
• 첫 글자 소문자
• 끝에 마침표 없음
• 한글로 작성 (파일명, 고유명사 제외)

커밋 분리 원칙

• 기능별로 잘게 쪼개서 커밋
• 관련 파일끼리 묶어서 커밋
• 문서는 코드와 함께 또는 별도 커밋

커밋 명령 형식

git add <files>
git commit -m "$(cat <<'EOF'
<type>: <한글 설명>

<필요시 상세 내용>

EOF
)"

4단계: 결과 보고

# 생성된 커밋 확인
git log --oneline -n <count>

보고 내용:

• 생성된 커밋 목록
• 업데이트된 문서 목록
• 남은 작업 여부