Git Flow

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

시작 → main (Master) 브랜치 생성 → Develop 브랜치 분기
                                    ↓
                            Feature 브랜치 생성
                                    ↓
                            기능 개발 완료
                                    ↓
                        Develop 브랜치로 병합
                                    ↓
                        Release 브랜치 생성
                                    ↓
                    품질 검증 및 버그 수정
                            /               \
                Develop 브랜치로 병합    main (Master) 브랜치로 병합
                                            ↓
                                    버전 태그 생성
                                            ↓
                                    Hotfix 필요시
                                            ↓
                                Hotfix 브랜치 생성
                                            ↓
                                    버그 수정
                            /                       \
                main (Master) 브랜치로 병합        Develop 브랜치로 병합

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

┌─────────────────────────────────────────────────────┐
│                Git Flow Architecture                 │
├─────────────────────────────────────────────────────┤
│  장기 브랜치:                                       │
│  ┌─────────┐        ┌──────────┐                   │
│  │ Master  │◄───────│ Develop  │                   │
│  └─────────┘        └──────────┘                   │
│       ▲                   ▲                        │
│       │                   │                        │
│  단기 브랜치:             │                        │
│  ┌─────────┐         ┌──────────┐                  │
│  │ Hotfix  │         │ Feature  │                  │
│  └─────────┘         └──────────┘                  │
│       │                   │                        │
│       │              ┌──────────┐                  │
│       └──────────────│ Release  │                  │
│                      └──────────┘                  │
└─────────────────────────────────────────────────────┘

1

MAJOR.MINOR.PATCH

 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

name: Auto Version and Release
on:
  push:
    branches:
      - prod
jobs:
  version:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Extract version from branch
        id: extract_version
        run: |
          # release 브랜치명에서 버전 추출
      - name: Get previous tag
        id: get_previous_tag
        run: |
          # 이전 태그 가져오기
      - name: Get commits between tags
        id: get_commits_between
        run: |
          # 커밋 로그 추출
      - name: Create tag
        run: |
          # 태그 생성 및 푸시
      - name: Create GitHub Release
        uses: softprops/action-gh-release@v1
        with:
          tag_name: ${{ steps.extract_version.outputs.version }}
          name: '${{ steps.extract_version.outputs.version }}'
          body: |
            ## 변경 사항
            ${{ steps.get_commits_between.outputs.commits }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# 원격 저장소 추가
git remote add origin https://github.com/username/my-ecommerce-project.git
git remote add origin git@github.com:username/my-ecommerce-project.git

# 현재 브랜치명이 main이면 그대로 푸시
git push -u origin main

# 또는 master를 main으로 변경 후 푸시
git branch -M main
git push -u origin main

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

Which branch should be used for bringing forth production releases?
   - master
Branch name for production releases: [master] 
Branch name for "next release" development: [develop] 

How to name your supporting branch prefixes?
Feature branches? [feature/] 
Release branches? [release/] 
Hotfix branches? [hotfix/] 
Support branches? [support/] 
Version tag prefix? [] v

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

# Git Flow 초기화 후 설정은 .git/config에 저장됩니다
cat .git/config

[gitflow "branch"]
    master = main
    develop = develop
[gitflow "prefix"]
    feature = feature/
    bugfix = bugfix/
    release = release/
    hotfix = hotfix/
    support = support/
    versiontag = v

 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

실제 프로젝트 Git Flow 워크플로우 예시:

초기 상태:
master   ○ v0.1.0
         │
develop  ○
         
1. 새로운 기능 개발:
master   ○ v0.1.0
         │
develop  ○────────○
         │        ↑
feature  └─○─○─○──┘ (결제 API 통합)

2. 릴리즈 준비:
master   ○ v0.1.0                    ○ v1.0.0
         │                           ↑
release  │                 ○─○─○─○─○─┘ (QA 및 버그 수정)
         │                 ↑         ↑
develop  ○────────○────────○─────────○
         
3. 핫픽스 처리:
master   ○ v0.1.0             ○ v1.0.0    ○ v1.0.1
         │                    │           ↑
hotfix   │                    │    ○─○────┘ (보안 패치)
         │                    │    ↑      ↑
develop  ○────────○────────○──○────○──────○

4. 다음 기능 개발 주기:
master   ○ v0.1.0             ○ v1.0.0    ○ v1.0.1
         │                    │           │
develop  ○────────○────────○──○────○──────○────○────○
         │                        │              ↑
feature  │                        └─○─○─○────────┘ (사용자 프로필)
         │                                       ↑
feature  └───────────────────────────○─○─○──○────┘ (알림 시스템)

1
2
3
4
5
6

# 프로젝트 초기화
git init
git checkout -b develop
git checkout -b master
git tag -a v0.1.0 -m "Initial MVP release"
git checkout develop

1
2

git checkout develop
git checkout -b feature/payment-api-integration

1
2
3
4

# payment/config.js 생성
# payment/stripe-service.js 생성
git add payment/
git commit -m "feat: add Stripe API configuration and service setup"

1
2
3
4
5
6
7
8

# payment/checkout-controller.js 생성
# payment/payment-processor.js 생성
git add payment/
git commit -m "feat: implement payment processing logic

- Add checkout controller
- Create payment processor with Stripe integration
- Handle payment intents and confirmations"

1
2
3
4
5
6
7
8
9

# components/CheckoutForm.js 생성
# components/PaymentStatus.js 생성
# tests/payment.test.js 생성
git add components/ tests/
git commit -m "feat: add payment UI components and tests

- Create checkout form with card input
- Add payment status component
- Include unit tests for payment flow"

1
2
3
4

# 코드 리뷰 후 develop에 머지
git checkout develop
git merge --no-ff feature/payment-api-integration
git branch -d feature/payment-api-integration

1
2

git checkout develop
git checkout -b release/v1.0.0

1
2

# 결제 실패 시 에러 처리 개선
git commit -am "fix: improve error handling for failed payments"

1
2

# 모바일 환경에서 결제 폼 레이아웃 수정
git commit -am "fix: adjust checkout form layout for mobile devices"

1
2
3
4

# README.md 업데이트
# CHANGELOG.md 작성
git add README.md CHANGELOG.md
git commit -m "docs: update documentation for v1.0.0 release"

1
2

# 이미지 최적화 및 번들 크기 감소
git commit -am "perf: optimize images and reduce bundle size"

1
2

# package.json 버전 업데이트
git commit -am "chore: bump version to 1.0.0"

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

# master에 머지
git checkout master
git merge --no-ff release/v1.0.0
git tag -a v1.0.0 -m "Release version 1.0.0

Features:
- Payment API integration with Stripe
- Improved checkout process
- Mobile-responsive payment forms

Bug fixes:
- Enhanced error handling
- Mobile layout improvements"

# develop에도 머지
git checkout develop
git merge --no-ff release/v1.0.0
git branch -d release/v1.0.0

1
2

git checkout master
git checkout -b hotfix/v1.0.1-security-patch

1
2
3
4
5
6
7
8

# utils/sanitizer.js 생성
# components/ProductReview.js 수정
git add utils/sanitizer.js
git commit -am "fix: add input sanitization to prevent XSS attacks

- Create sanitizer utility
- Apply sanitization to user inputs
- Update product review component"

1
2
3

# tests/security.test.js 생성
git add tests/security.test.js
git commit -m "test: add security tests for XSS prevention"

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

# 버전 업데이트
git commit -am "chore: bump version to 1.0.1"

# master에 머지
git checkout master
git merge --no-ff hotfix/v1.0.1-security-patch
git tag -a v1.0.1 -m "Security patch release

Security fixes:
- Fixed XSS vulnerability in product reviews
- Added input sanitization
- Improved security testing"

# develop에도 머지
git checkout develop
git merge --no-ff hotfix/v1.0.1-security-patch
git branch -d hotfix/v1.0.1-security-patch

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

git checkout develop
git checkout -b feature/user-profile

# 개발 작업
git commit -m "feat: add user profile page component"
git commit -m "feat: implement profile editing functionality"
git commit -m "feat: add avatar upload feature"

# develop에 머지
git checkout develop
git merge --no-ff feature/user-profile
git branch -d feature/user-profile

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

git checkout develop
git checkout -b feature/notification-system

# 개발 작업
git commit -m "feat: create notification service"
git commit -m "feat: implement real-time notifications with WebSocket"
git commit -m "feat: add email notification templates"
git commit -m "feat: create notification preferences page"

# develop에 머지
git checkout develop
git merge --no-ff feature/notification-system
git branch -d feature/notification-system

1
2
3
4

(Local) develop ──▶ feature/user-authentication ──▶ (Remote) origin/feature/user-authentication
      │                                                │
      └───────────────────────────────▶ (merge) ──────▶ develop
      (병합 후 브랜치 삭제)

1
2
3
4

(Local) develop ──▶ release/v2.0.0 ──▶ (Remote) origin/release/v2.0.0
      │                                   │
      └─────────────▶ (merge) ───────────▶ master, develop (태그)
      (병합 후 브랜치 삭제)

1
2
3
4

(Local) master ──▶ hotfix/critical-security-patch ──▶ (Remote) origin/hotfix/critical-security-patch
      │                                                │
      └─────────────▶ (merge) ────────────▶ master, develop (태그)
      (병합 후 브랜치 삭제)

1
2
3
4
5
6

(Local) develop ──▶ team-a/feature-x ──▶ (Remote) origin/team-a/feature-x
      │                                    │
      └───────────────▶ (merge) ─────────▶ develop
(Local) develop ──▶ team-b/feature-y ──▶ (Remote) origin/team-b/feature-y
      │                                    │
      └───────────────▶ (merge) ─────────▶ develop

1
2
3
4
5
6

(Local) develop ──▶ feature/architecture-refactoring ──▶ (Remote) origin/feature/architecture-refactoring
      │
      ├─ (주기적 develop 병합)
      │
      └───────────────▶ (merge) ─────────▶ develop
      (병합 후 브랜치 삭제)

1
2
3
4

(Local) develop ──▶ release/api-v3.0 ──▶ (Remote) origin/release/api-v3.0
      │                                   │
      └─────────────▶ (merge) ───────────▶ master (태그), develop
      (병합 후 브랜치 삭제)

 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# CONTRIBUTING.md

## 환영합니다!
이 프로젝트에 기여해주셔서 감사합니다. 아래 가이드라인을 따라주시면 원활한 협업이 가능합니다.

---

## 브랜치 전략 (Git flow)
- `main`: 배포(프로덕션) 브랜치
- `develop`: 통합 개발 브랜치
- `feature/*`: 신규 기능 개발 (예: `feature/login`)
- `release/*`: 릴리즈 준비 (예: `release/v1.0.0`)
- `hotfix/*`: 긴급 수정 (예: `hotfix/issue-123`)

---

## 브랜치 네이밍 규칙
- 기능: `feature/<기능명>` (예: `feature/user-auth`)
- 릴리즈: `release/<버전>` (예: `release/1.2.0`)
- 핫픽스: `hotfix/<이슈번호-설명>` (예: `hotfix/102-login-bug`)

---

### Workflow Steps
1. Create a feature branch: `git flow feature start feature-name`
2. Make your changes and commit them
3. Finish the feature: `git flow feature finish feature-name`
4. Push changes to remote: `git push origin develop`

---

## 커밋 메시지 컨벤션
- [Conventional Commits](https://www.conventionalcommits.org/ko/v1.0.0/) 규칙 준수
- 예시:
	feat: 로그인 기능 추가  
	fix: 로그인 오류 수정  
	docs: README 업데이트
	
### Commit Message Format
<type>[<scope>]: <subject>
<body>
<footer> 

Types:
- feat: New feature
- fix: Bug fix
- docs: Documentation changes
- style: Code style changes
- refactor: Code refactoring
- test: Test updates
- chore: Build process updates

---

## Pull Request(PR) 절차
1. `develop` 브랜치에서 기능/이슈별 브랜치 생성
2. 작업 후 원격 저장소에 브랜치 push
3. PR 생성 시 관련 이슈 연결 및 상세 설명 작성
4. 최소 1인 이상 리뷰 및 승인 후 병합
5. 병합 후 브랜치 삭제

---

## 코드 스타일 & 품질 기준
- 코드 린트 및 포맷터 적용(프로젝트 내 설정 참고)
- 모든 PR은 테스트를 통과해야 함
- 문서(README 등) 최신화 필수

---

## 이슈 관리
- 새로운 기능/버그는 반드시 이슈 등록 후 작업
- PR은 관련 이슈 번호를 명시(예: `Fixes #123`)

---

## 기여 전 체크리스트
- [ ] 모든 테스트 통과
- [ ] 충돌 없음 확인
- [ ] 문서 최신화

---

## 문의 및 추가 정보
- 코드 오브 컨덕트: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
- 문의: maintainer@example.com

감사합니다!

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

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

# Run linting
npm run lint

# Run tests
npm run test

# Check commit message format
commit_msg=$(git log -1 --pretty=%B)
if ! echo "$commit_msg" | grep -qE "^(feat|fix|docs|style|refactor|test|chore)(\(.+\))?: .+"; then
    echo "Error: Commit message does not follow the conventional format"
    exit 1
fi

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

# 1. 저장소 클론
git clone https://github.com/company/project.git
cd project

# 2. Git Flow 설치 확인
git flow version

# 3. Git Flow 초기화 (이미 설정된 구성 사용)
git flow init -d

# 4. 최신 develop 브랜치로 전환
git checkout develop
git pull origin develop

# 5. 새 기능 작업 시작
git flow feature start my-first-feature