From 31473a2898589ec0c363d3e13a7698a926560935 Mon Sep 17 00:00:00 2001 From: Hyung1Jung Date: Mon, 24 May 2021 06:47:33 +0900 Subject: [PATCH] =?UTF-8?q?[#8]=20docs(.commit-message-template.txt)=20:?= =?UTF-8?q?=20=EC=BB=A4=EB=B0=8B=20=EB=A9=94=EC=84=B8=EC=A7=80=20=ED=85=9C?= =?UTF-8?q?=ED=94=8C=EB=A6=BF=20(#9)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/.commit-message-template.txt | 33 ++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/.commit-message-template.txt diff --git a/.github/.commit-message-template.txt b/.github/.commit-message-template.txt new file mode 100644 index 0000000..40e1b46 --- /dev/null +++ b/.github/.commit-message-template.txt @@ -0,0 +1,33 @@ +# --- 커밋 컨벤션 --- +# [현재 이슈 번호] 주제(Class/File명) : 본문 꼬리말 (관련 이슈 번호) +# 예) [#1] feat : 회원가입 기능 (#2) + +# --- 주제 List --- +# feat : 새로운 기능 추가 +# fix : 버그 수정 +# refactor : 프로덕션 코드 리펙토링, 새로운 기능이나 버그 수정없이 현재 구현을 개선한 경우 +# style : 코드 포맷팅(오타 수정, 변수명 변경등), 세미콜론 누락, 코드 변경이 없는 경우 +# docs : 문서 추가, 수정, 삭제 +# test : 테스트코드, 리펙토링 테스트 코드 추가, 수정, 삭제 +# chore : 빌드 업무 수정, 패키지 매니저 수정 +# comment : 필요한 주석 추가 및 변경 +# rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우 +# remove : 파일을 삭제하는 작업만 수행하는 경우 + +# --- 주제 --- +# 1. 주제 작성시 50자 이내로 작성합니다. +# 2. 제목 끝에 마침표를 넣지 않습니다. +# 3. 제목은 명령문으로 사용하며 과거형을 사용하지 않습니다. +# 4. 주제의 괄호안에 적는 Class/File명은 선택사항이므로 작성할 필요는 없습니다. + +# --- 본문 --- +# 1. 본문 작성시 제목과 본문 사이를 빈 행으로 구분합니다. +# 2. 각 행은 길이는 72자 이하로 제한합니다. +# 3. 어떻게 보다는 무엇과 왜를 설명합니다. +# 4. 본문 내용은 선택사항이므로 모든 커밋에 본문 내용을 작성할 필요는 없습니다. + +# --- 꼬리말 --- +# 1. 관련 이슈를 참조하는데 사용됩니다. +# 2. 관련된 이슈 번호를 적고, 여러개 적어도 상관 없습니다. +# 3. 선택사항이므로 모든 커밋에 꼬리말을 작성할 필요는 없습니다. +