Git 워크플로우

1
2
3
4
5
6
7
8
9

# 기능별
feat(user): add user registration
feat(auth): implement OAuth2 login
feat(order): add payment processing

# 레이어별
fix(controller): fix validation error
refactor(service): extract common logic
test(repository): add integration tests

1
2
3
4
5
6
7
8
9

# ✅ GOOD
feat(user): add email verification
fix(auth): resolve token expiration issue
docs(api): update REST API documentation

# ❌ BAD
feat(user): Added email verification feature.  # 과거형, 마침표
Fix Auth: Token Expiration  # 대문자 시작
feat: this is a very long commit message that exceeds 50 characters  # 너무 김

1
2
3
4
5
6
7
8

# ✅ GOOD: 각 변경사항을 별도 커밋으로 분리
git commit -m "feat(user): add User entity"
git commit -m "feat(user): add UserRepository"
git commit -m "feat(user): add UserService"
git commit -m "test(user): add UserService tests"

# ❌ BAD: 여러 변경사항을 하나의 커밋으로
git commit -m "feat(user): add user feature"  # Entity, Repository, Service, Test 모두 포함

1
2
3
4
5
6
7
8
9

# 작업 중간 커밋
git commit -m "wip: implementing user service"
git commit -m "wip: add validation logic"
git commit -m "wip: fix typo"

# PR 전에 불필요한 커밋 중복은 반드시 Squash
git rebase -i HEAD~3
# pick → squash로 변경
# 최종 커밋 메시지 작성: "feat(user): add UserService with validation"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

# 기능 개발
feature/ISSUE-123
feature/add-payment-gateway

# 버그 수정
bugfix/ISSUE-456
bugfix/fix-null-pointer

# 핫픽스
hotfix/ISSUE-789
hotfix/critical-db-connection

# 릴리즈
release/v1.0.0
release/v2.0.0-beta

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

# 1. develop에서 최신 코드 받기
git checkout develop
git pull origin develop

# 2. feature 브랜치 생성
git checkout -b feature/ISSUE-123

# 3. 작업 및 커밋 (원자적 커밋)
git add src/main/User.kt
git commit -m "feat(user): add User entity"

git add src/main/UserRepository.kt
git commit -m "feat(user): add UserRepository"

git add src/test/UserServiceTest.kt
git commit -m "test(user): add UserService tests"

# 4. 원격 브랜치에 푸시
git push origin feature/ISSUE-123

# 5. PR 생성 (GitHub, GitLab 등)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

## 작업 내용
사용자 인증 기능을 추가했습니다.

## 관련 이슈
Closes #123

## 작업 사항
- User 엔티티 추가
- UserRepository 추가
- UserService 및 단위 테스트 추가

## 테스트
- [x] 로컬 테스트 완료
- [x] 단위 테스트 작성
- [x] 통합 테스트 통과

## 체크리스트
- [x] Git Convention 준수
- [x] 코드 리뷰 준비 완료
- [x] Breaking Change 없음

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

# Squash and Merge
# - 여러 커밋을 하나로 합침
# - 깔끔한 히스토리 유지
git merge --squash feature/ISSUE-123

# Rebase and Merge
# - 커밋을 그대로 유지하되 일렬로 정렬
git rebase develop
git merge feature/ISSUE-123

# Merge Commit
# - 머지 커밋을 남김
git merge feature/ISSUE-123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

#!/bin/bash
# .git/hooks/pre-commit

# 코드 포맷 체크
./gradlew ktlintCheck || {
    echo "❌ ktlint check failed"
    exit 1
}

# 테스트 실행
./gradlew test || {
    echo "❌ Tests failed"
    exit 1
}

echo "✅ Pre-commit checks passed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/bin/bash
# .git/hooks/commit-msg

commit_msg=$(cat "$1")
pattern="^(feat|fix|docs|style|refactor|test|chore|perf)(\(.+\))?: .+"

if ! echo "$commit_msg" | grep -qE "$pattern"; then
    echo "❌ Invalid commit message format"
    echo "Format: <type>(<scope>): <subject>"
    echo "Example: feat(user): add user registration"
    exit 1
fi

echo "✅ Commit message format is valid"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

# 1. 최신 코드 받기
git fetch origin

# 2. Rebase로 충돌 해결 (권장)
git rebase origin/develop

# 3. 충돌 파일 수정
# (충돌 마커 <<<<<<, ======, >>>>>> 제거)

# 4. 계속 진행
git add <resolved-files>
git rebase --continue

# 5. 원격 브랜치에 강제 푸시 (주의!)
git push origin feature/ISSUE-123 --force

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# .gitignore

# 환경 변수 및 설정 파일
.env
.env.local
.env.*.local
application-local.yml
application-secret.yml

# IDE 설정 (팀 공유 설정 제외)
.idea/
.vscode/
*.swp
*.swo

# 빌드 결과물
build/
target/
dist/
*.jar
*.war

# 로그 파일
*.log
logs/

# 데이터베이스
*.db
*.sqlite

# OS 파일
.DS_Store
Thumbs.db

# 민감한 설정 파일
*-secret.yml
*-credentials.json
*.pem
*.key

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# ❌ BAD: 민감정보를 커밋
git add .env
git commit -m "feat: add environment variables"

# ✅ GOOD: .gitignore에 추가
echo ".env" >> .gitignore
git add .gitignore
git commit -m "chore: add .env to gitignore"

# 민감정보 템플릿 파일 제공
cp .env .env.example
# .env.example에서 실제 값 제거
git add .env.example
git commit -m "docs: add env example file"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# ❌ 이미 커밋된 경우: git-filter-repo 사용
pip install git-filter-repo

# 특정 파일 히스토리에서 완전 제거
git filter-repo --path .env --invert-paths

# 또는 BFG Repo-Cleaner 사용
java -jar bfg.jar --delete-files .env

# 강제 푸시 (주의: 팀원과 사전 협의 필수)
git push origin --force --all

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

#!/bin/bash
# .git/hooks/pre-commit

# 민감한 패턴 검사
PATTERNS=(
    "password\s*=\s*['\"][^'\"]+['\"]"
    "api_key\s*=\s*['\"][^'\"]+['\"]"
    "secret\s*=\s*['\"][^'\"]+['\"]"
    "AWS_SECRET_ACCESS_KEY"
    "PRIVATE_KEY"
)

for pattern in "${PATTERNS[@]}"; do
    if git diff --cached | grep -qE "$pattern"; then
        echo "Error: Potential sensitive information detected!"
        echo "Pattern: $pattern"
        exit 1
    fi
done

echo "Pre-commit checks passed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

## 코드 리뷰 체크리스트

### 기능 (Functionality)
- [ ] 요구사항을 정확히 구현했는가?
- [ ] Edge case를 고려했는가?
- [ ] 에러 처리가 적절한가?

### 코드 품질 (Code Quality)
- [ ] 코딩 컨벤션을 준수했는가?
- [ ] 불필요한 코드가 없는가?
- [ ] 복잡한 로직에 주석이 있는가?

### 보안 (Security)
- [ ] 입력 검증이 있는가?
- [ ] SQL Injection 취약점이 없는가?
- [ ] 민감정보가 노출되지 않는가?

### 테스트 (Testing)
- [ ] 단위 테스트가 작성되었는가?
- [ ] 테스트 커버리지가 충분한가?
- [ ] 기존 테스트가 모두 통과하는가?

### 성능 (Performance)
- [ ] 성능 저하가 없는가?
- [ ] N+1 쿼리 문제가 없는가?
- [ ] 불필요한 API 호출이 없는가?

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

# PR 생성 전 Self-Review
git diff origin/main...HEAD

# 모든 테스트 실행
./gradlew test

# 코드 포맷팅
./gradlew ktlintFormat

# PR 생성 시 명확한 설명 작성
# - 무엇을 변경했는지
# - 왜 변경했는지
# - 어떻게 테스트했는지

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# package.json
{
  "devDependencies": {
    "@commitlint/cli": "^17.0.0",
    "@commitlint/config-conventional": "^17.0.0",
    "husky": "^8.0.0"
  }
}

# commitlint.config.js
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore', 'perf']
    ],
    'subject-max-length': [2, 'always', 50]
  }
}

# Husky 설정
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

## 변경 사항 (Changes)
<!-- 무엇을 변경했는지 간단히 설명 -->

## 변경 이유 (Why)
<!-- 왜 이 변경이 필요한지 설명 -->

## 관련 이슈 (Related Issues)
Closes #

## 변경 타입 (Type of Change)
- [ ] 새로운 기능 (feat)
- [ ] 버그 수정 (fix)
- [ ] 리팩토링 (refactor)
- [ ] 문서 수정 (docs)
- [ ] 성능 개선 (perf)
- [ ] Breaking Change

## 테스트 (Testing)
- [ ] 단위 테스트 작성
- [ ] 통합 테스트 작성
- [ ] 수동 테스트 완료
- [ ] 테스트 시나리오:

## 스크린샷 (Screenshots)
<!-- UI 변경이 있는 경우 스크린샷 첨부 -->

## 체크리스트 (Checklist)
- [ ] 코딩 컨벤션 준수
- [ ] 자체 리뷰 완료
- [ ] 문서 업데이트 (필요시)
- [ ] Breaking Change 문서화 (필요시)

## 추가 정보 (Additional Notes)
<!-- 리뷰어가 알아야 할 추가 정보 -->

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

# Settings → Branches → Branch protection rules

main:
  - Require pull request reviews before merging: ✅
  - Require status checks to pass before merging: ✅
    - CI/CD tests
    - Code coverage
    - Security scan
  - Require conversation resolution before merging: ✅
  - Require linear history: ✅
  - Do not allow bypassing the above settings: ✅

develop:
  - Require pull request reviews before merging: ✅
  - Require status checks to pass before merging: ✅