Skip to content

Commit e98be70

Browse files
authoredDec 1, 2022
[docs] CONTRIBUTING.md D-n룰 추가
1 parent 84ddca4 commit e98be70

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed
 

‎CONTRIBUTING.md

+33-8
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,8 @@
33
Contributor로서 다음과 같은 지침을 준수해주세요.
44

55
- [Submission Guidelines](#submission-guidelines)
6-
- [Issue 제출하기](#📌-issue-제출하기)
7-
- [Pull Request 제출하기](#📌-pull-request-제출하기)
8-
- [Pull Request 리뷰하기](#📌-pull-request-리뷰하기)
96
- [Git Commit Message Convention](#git-commit-message-convention)
10-
- [Commit Message Header](#📌-commit-message-header)
11-
- [Commit Message Body](#📌-commit-message-body)
12-
- [Commit Message Footer](#📌-commit-message-footer)
13-
7+
148
## **Submission Guidelines**
159

1610
### **📌 Issue 제출하기**
@@ -22,6 +16,8 @@ Contributor로서 다음과 같은 지침을 준수해주세요.
2216
3. 관련있는 Label를 추가합니다.
2317
4. 템플릿 컨벤션을 준수하여 제출해주세요.
2418

19+
<br>
20+
2521
### **📌 Pull Request 제출하기**
2622

2723
당신의 Pull Request를 제출하기 전에 다음 사항을 따라주세요:
@@ -49,6 +45,21 @@ Contributor로서 다음과 같은 지침을 준수해주세요.
4945
5. 해당 브랜치에 push해주세요.
5046

5147
6. Github에서 템플릿 컨벤션을 준수하여 Pull Request를 제출해주세요.
48+
7. 리뷰 우선순위 판단을 돕는 `D-n 룰`을 사용하여 해당 label을 붙여주세요.
49+
50+
7-1. **D-n룰**
51+
52+
- **`D-0` (ASAP)**
53+
54+
긴급한 수정사항으로 바로 리뷰해 주세요. 앱의 오류로 인해 장애가 발생하거나, 빌드가 되지 않는 등 긴급 이슈가 발생할 때 사용합니다.
55+
56+
- **`D-N` (Within N days)**
57+
58+
N일 이내에 리뷰해 주세요.
59+
60+
일반적으로 D-2 태그를 많이 사용하며, 중요도가 낮거나 일정이 여유 있는 경우 D-3 ~ D-5 를 사용하기도 합니다.
61+
62+
<br>
5263

5364
### **📌 Pull Request 리뷰하기**
5465

@@ -82,6 +93,10 @@ PR의 reivewer라면 다음 사항을 따라주세요:
8293

8394
3. 해당 PR reviewer가 **Approve**를 하면 머지를 할 수 있습니다.
8495

96+
<br>
97+
<br>
98+
99+
85100
## **Git Commit Message Convention**
86101

87102
### **📌 Commit Message Header**
@@ -96,6 +111,8 @@ PR의 reivewer라면 다음 사항을 따라주세요:
96111
└─⫸ Commit Type
97112
```
98113

114+
<br>
115+
99116
### **타입**
100117

101118
다음 중 하나여야 합니다.
@@ -113,13 +130,17 @@ PR의 reivewer라면 다음 사항을 따라주세요:
113130
🔥 [remove] : 파일, 폴더 삭제 작업
114131
```
115132

133+
<br>
134+
116135
### **제목**
117136

118137
변경 사항에 대한 간략한 설명을 제공합니다.
119138

120139
- 제목은 명령문 한글로 작성합니다.
121140
- 끝에는 마침표 (.)가 없습니다.
122141

142+
<br>
143+
123144
### **📌 Commit Message Body**
124145

125146
어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 최대한 상세히 설명합니다.
@@ -128,12 +149,16 @@ PR의 reivewer라면 다음 사항을 따라주세요:
128149
- 한 줄 당 72자 내로 작성합니다.
129150
- 여러 줄의 메시지를 작성할 땐 "-"로 구분합니다.
130151

152+
<br>
153+
131154
### **📌 Commit Message Footer**
132155

133156
현재 커밋과 관련된 이슈 번호로 작성합니다.
134157

135158
- ex) `#이슈번호`
136159

160+
<br>
161+
137162
## PR Merge Type
138163

139-
- Create a merge commit type을 사용합니다.
164+
- Create a merge commit type을 사용합니다.

0 commit comments

Comments
 (0)