Git 워크플로우 강제 도구은(는) 무엇을 하나요?
커밋 메시지, 브랜치 명명, PR 프로세스 등 일관된 Git 워크플로우를 강제합니다.
사용 시점
- 커밋 또는 브랜치 생성 시
- 코드 리뷰 또는 PR 생성 시
- 사용자가 "git 워크플로우", "커밋 메시지", "브랜치 명명", "풀 리퀘스트"를 언급할 때
지침
1. 기존 규칙 감지
다음을 확인하세요:
.github/또는.gitlab/템플릿CONTRIBUTING.md- 기존 커밋 메시지 패턴
- 브랜치 명명 패턴
2. Conventional Commits
형식: type(scope): description
타입:
feat: 새 기능fix: 버그 수정docs: 문서style: 서식, 세미콜론 누락refactor: 코드 구조 변경perf: 성능 개선test: 테스트 추가chore: 유지보수, 의존성
예시:
feat(auth): add OAuth2 login support
fix(api): handle null response in user endpoint
docs(readme): update installation instructions
refactor(utils): simplify date formatting logic
3. 브랜치 명명
일반 패턴:
feature/user-authentication
bugfix/login-error-handling
hotfix/critical-security-patch
release/v1.2.0
chore/update-dependencies
검증:
- 소문자와 하이픈 사용
- 타입으로 접두사
- 설명적인 이름
- 해당 이슈 번호 있으면 포함:
feature/123-add-dark-mode
4. 커밋 메시지 검증
좋은 커밋:
feat(payments): integrate Stripe payment gateway
- Add Stripe SDK configuration
- Implement payment intent creation
- Add webhook handler for payment events
- Update tests for payment flow
Closes #456
확인할 사항:
- 제목 줄 ≤50자
- 본문 72자에서 줄 바꿈
- 제목과 본문 사이에 빈 줄
- 명령형 사용 ("added"가 아닌 "add")
- 이슈/티켓 참조
5. PR 템플릿
.github/PULL_REQUEST_TEMPLATE.md 생성:
## 설명
<!-- 이 PR이 무엇을 하나요? -->
## 변경 유형
- [ ] 버그 수정
- [ ] 새 기능
- [ ] 호환성을 깨는 변경
- [ ] 문서 업데이트
## 테스트
<!-- 어떻게 테스트했나요? -->
## 체크리스트
- [ ] 코드가 프로젝트 스타일 가이드라인을 따릅니다
- [ ] 자체 리뷰 완료
- [ ] 복잡한 코드에 주석 추가
- [ ] 문서 업데이트됨
- [ ] 테스트 추가/업데이트됨
- [ ] 모든 테스트 통과
- [ ] 새로운 경고 없음
## 관련 이슈
Closes #
6. 커밋 훅
Pre-commit:
#!/bin/sh
# .git/hooks/pre-commit
# 린터 실행
npm run lint
# 테스트 실행
npm test
# 민감 데이터 확인
if git diff --cached | grep -i "password\|api_key\|secret"; then
echo "오류: 민감한 데이터가 감지되었습니다"
exit 1
fi
Commit-msg:
#!/bin/sh
# .git/hooks/commit-msg
commit_msg=$(cat "$1")
# Conventional Commit 형식 확인
if ! echo "$commit_msg" | grep -qE "^(feat|fix|docs|style|refactor|perf|test|chore)(\(.+\))?: .+"; then
echo "오류: 커밋 메시지는 Conventional Commits 형식을 따라야 합니다"
echo "예시: feat(auth): add login feature"
exit 1
fi
7. 기존 커밋 검증
최근 커밋이 패턴을 따르는지 확인:
git log --oneline -20 | grep -v "^[a-f0-9]\{7\} (feat|fix|docs|style|refactor|perf|test|chore)"
8. Changelog 생성
Conventional Commits에서:
# standard-version 사용
npx standard-version
# 또는 유형별로 수동 그룹화
git log --pretty=format:"%s" | grep "^feat" > features.txt
git log --pretty=format:"%s" | grep "^fix" > fixes.txt
9. 보호된 브랜치
GitHub 설정:
- PR 리뷰 필수
- 상태 확인 필수
- 서명된 커밋 필수
- 푸시 가능한 사용자 제한
- 선형 히스토리 필수
10. 모범 사례
- 원자적 커밋: 커밋당 하나의 논리적 변경
- 설명적인 메시지: 무엇이 아니라 왜를 설명
- 빈번한 커밋: 크고 드문 것보다 작고 빈번하게
- 깨끗한 히스토리: 병합 전 squash/rebase
- 커밋 서명: 보안을 위해 GPG 서명
- 이슈 참조: 추적 시스템에 연결
Git 커밋 템플릿
.gitmessage 생성:
<type>(<scope>): <subject>
<body>
<footer>
# Type: feat, fix, docs, style, refactor, perf, test, chore
# Scope: 영향을 받는 컴포넌트 또는 파일
# Subject: 명령형, 소문자, 마침표 없음, 50자 이하
# Body: 무엇과 왜를 설명, 어떻게는 제외, 72자에서 줄 바꿈
# Footer: 호환성을 깨는 변경, 이슈 참조
템플릿으로 설정:
git config --global commit.template ~/.gitmessage
지원 파일
templates/PULL_REQUEST_TEMPLATE.mdtemplates/commit-msg-hook.shtemplates/.gitmessage