Docs: fix commit template

boostcampaitech5 · May 9, 2023 · 82757d6 · 82757d6
1 parent eab4a9a
commit 82757d6
Showing 1 changed file with 32 additions and 28 deletions.
diff --git a/gitcommit_template.txt b/gitcommit_template.txt
@@ -1,35 +1,39 @@
-# 제목은 최대 50글자까지 아래에 작성: ex) Feat: Add Key mapping  
+# Subject should be under 50 character (ex. Feat: Add Key mapping)  
 
 
-# 본문은 아래에 작성  
+# Write body underneath  
 
-# 꼬릿말은 아래에 작성: ex) Github issue #23  
+
+# Write Footer underneath (ex. Github issue #23)  
 
 # --- COMMIT END ---  
-#   <타입> 리스트  
-#   feat        : 기능 (새로운 기능)  
-#   fix         : 버그 (버그 수정)  
-#   refactor    : 리팩토링  
-#   design      : CSS 등 사용자 UI 디자인 변경   
-#   style       : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)  
-#   docs        : 문서 수정 (문서 추가, 수정, 삭제, README), 주석 수정  
-#   test        : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)  
-#   chore       : 기타 변경사항 (빌드 스크립트 수정, assets, 패키지 매니저 등)  
-#   init        : 초기 생성  
-#   rename      : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 한 경우  
-#   remove      : 파일을 삭제하는 작업만 수행한 경우  
+#   <type> list  
+#   feat        : feature (new feature)  
+#   fix         : bug (bug fix)  
+#   refactor    : refactoring  
+#   design      : UI or design (ex. css)   
+#   style       : style (code format)  
+#   docs        : documentation (document add, fix, delete, README), annotation fix  
+#   test        : test (test code add, fix, change)  
+#   chore       : other changes (build script fix, assets, package manager etc..)  
+#   init        : project initialization  
+#   rename      : renaming files or directories 
+#   remove      : deleting files or directories 
+# ------------------  
+#   <Subject>  
+#   First character of Subject must be capitalized  
+#   write in statement  
+#   "." is not allowed  
+#   seperate Subject and Body with a new line feed  
 # ------------------  
-#   제목 첫 글자를 대문자로  
-#   제목은 명령문으로  
-#   제목 끝에 마침표(.) 금지  
-#   제목과 본문을 한 줄 띄워 분리하기  
-#   본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.  
-#   본문에 여러줄의 메시지를 작성할 땐 "-"로 구분  
+#   <Body>  
+#   write "what" you did and "why" you did it  
+#   each line should be under 72 character  
 # ------------------  
-#   <꼬리말>  
-#   필수가 아닌 optioanl  
-#   Fixes        :이슈 수정중 (아직 해결되지 않은 경우)  
-#   Resolves     : 이슈 해결했을 때 사용  
-#   Ref          : 참고할 이슈가 있을 때 사용  
-#   Related to   : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)  
-#   ex) Fixes: #47 Related to: #32, #21 
+#   <Footer>  
+#   Footer is optional  
+#   Fixes        : issue currently fixing (if not resolved)  
+#   Resolves     : if issue is resolved  
+#   Ref          : if there is a issue to refer 
+#   Related to   : related issue for this commit (if not resolved)  
+#   (ex. Fixes: #47 Related to: #32, #21)