File tree 1 file changed +52
-0
lines changed
1 file changed +52
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Branch Guidelines
2
+
3
+ ## 개요
4
+
5
+ 이 문서는 이 프로젝트에서의 브랜치 전략과 작업 방식에 대해 설명합니다.
6
+ 새로운 기여자가 쉽게 이해하고 따를 수 있도록, 실제 작업 예시와 함께 브랜치 사용 규칙을 문서화합니다.
7
+
8
+ ## 브랜치 네이밍 규칙
9
+
10
+ - 브랜치 이름 형식: ` feature/이슈번호-작업내용 `
11
+ - 예시: ` feature/32-branch-guidelines `
12
+
13
+ ## 작업 절차 예시
14
+
15
+ 1 . ** 문제점 발견**
16
+ - 작업이 필요한 버그나 개선 사항 등을 발견합니다.
17
+
18
+ 2 . ** 이슈 생성**
19
+ - GitHub 또는 이슈 트래커에 이슈를 등록합니다.
20
+ - 이슈 템플릿:
21
+
22
+ ```
23
+ - Why❓ : 이 작업이 필요한 이유
24
+ - How❓ : 해결 방법 또는 접근 방식
25
+ - What❓ : 작업해야 할 구체적인 내용
26
+ ```
27
+
28
+ 3. **master 브랜치 최신화**
29
+ - 로컬 환경에서 `master` 브랜치를 최신 상태로 유지합니다.
30
+
31
+ 4. **작업 브랜치 생성**
32
+ - 위의 네이밍 규칙에 따라 새로운 브랜치를 생성합니다.
33
+ - 예시: `feature/32-branch-guidelines`
34
+
35
+ 5. **작업 수행**
36
+ - 필요한 기능 구현 또는 코드 수정을 진행합니다.
37
+
38
+ 6. **Pull Request(PR) 생성**
39
+ - 작업이 완료되면 `master` 브랜치 대상으로 PR을 생성합니다.
40
+ - PR 제목과 설명에는 이슈 번호를 명시합니다.
41
+
42
+ 7. **리뷰 요청**
43
+ - 최소 2명의 팀원에게 코드 리뷰를 요청합니다.
44
+
45
+ 8. **병합(Merge)**
46
+ - 리뷰 승인을 받은 후 `master` 브랜치에 병합합니다.
47
+
48
+ ## 참고 사항
49
+
50
+ - 가능하면 커밋 메시지도 의미 있게 작성해주세요.
51
+ - 필요 시 `hotfix/`, `bugfix/`, `refactor/` 등 브랜치 접두어를 추가로 사용할 수 있습니다.
52
+ - PR에는 작업 목적, 변경 내용, 테스트 방법 등을 명확히 기술해주세요.
You can’t perform that action at this time.
0 commit comments