From 0224ce05393b0caf8b57c2c623baae4bcba225b4 Mon Sep 17 00:00:00 2001 From: Zamoca Date: Wed, 25 Oct 2023 14:36:27 +0900 Subject: [PATCH] =?UTF-8?q?Docs:=20=ED=85=9C=ED=94=8C=EB=A6=BF=20=EC=B6=94?= =?UTF-8?q?=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 일관성 있는 협업을 위해 PR/버그/이슈/커밋 템플릿 추가 Related to #1 --- .github/ISSUE_TEMPLATE/bug.md | 27 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/issue.md | 28 ++++++++++++++++++++++++ .github/pull_request_template.md | 37 ++++++++++++++++++++++++++++++++ .gitmessage.txt | 31 ++++++++++++++++++++++++++ 4 files changed, 123 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/issue.md create mode 100644 .github/pull_request_template.md create mode 100644 .gitmessage.txt diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..c96b671 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,27 @@ +--- +name: Bug template +about: 버그 발생 시 사용하는 템플릿입니다 +title: "버그 리포트" +labels: "bug" +assignees: + +--- + +## 버그에 대한 설명 +버그가 무엇인지 명확하고 간결하게 설명합니다. + +## 재현 방법 +어떤 식으로 발생했는지 순서대로 작성해주세요: +1. 어디를 가서 '....' +2. 어떤 행동을 했더니 '...' +3. 에러가 나왔다 ' ... ' + +## 예상 동작 +발생할 것으로 예상한 사항에 대한 명확하고 간결한 설명. + +## 스크린샷 +해당하는 경우 스크린샷을 추가하여 문제를 설명. + + +## 추가 내용 +여기에 문제에 대한 다른 내용을 추가합니다. diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md new file mode 100644 index 0000000..f1a746d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue.md @@ -0,0 +1,28 @@ +--- +name: Issue template +about: 이슈 작성 시 사용하는 템플릿입니다 +title: "이슈 리포트" +labels: "" +assignees: + +--- + +## 이슈 내용 +> 이슈 내용 작성 + +
+ +## 작업 사항 +- [ ] 해당 이슈의 작업사항 + +
+ +## 관련 이슈 +- #이슈 번호 + +
+ +## 기타사항 + + +
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..96e4408 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,37 @@ +## PR 체크리스트 +아래 항목을 확인해 주세요: + +- [ ] 커밋 메시지가 우리의 가이드라인을 따르고 있는지 확인하세요 +- [ ] 변경 사항에 대한 테스트가 추가되었는지 확인하세요 (버그 수정 / 기능 추가) +- [ ] 문서가 추가되거나 업데이트되었는지 확인하세요 (버그 수정 / 기능 추가) + +## PR 유형 +이 PR은 어떤 종류의 변경을 가져오나요? + + + +- [ ] 버그 수정 +- [ ] 새로운 기능 추가 +- [ ] 코드 스타일 업데이트 (서식, 로컬 변수) +- [ ] 리팩터링 (기능 변경 없음, API 변경 없음) +- [ ] 빌드 관련 변경 +- [ ] CI 관련 변경 +- [ ] 문서 내용 변경 +- [ ] 애플리케이션 / 인프라 변경 +- [ ] 기타... 설명: + +## 현재 동작은 무엇인가요? + + +이슈 번호: N/A + +## 새로운 동작은 무엇인가요? + +## 이 PR은 호환성 변경을 도입하나요? + +- [ ] 예 +- [ ] 아니요 + + + +## 기타 정보 diff --git a/.gitmessage.txt b/.gitmessage.txt new file mode 100644 index 0000000..73dd158 --- /dev/null +++ b/.gitmessage.txt @@ -0,0 +1,31 @@ +################ +# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성 +# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지 +# 예) Feat : 로그인 기능 추가 # 이슈번호 + +# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함) + +################ +# 본문(구체적인 내용)을 아랫줄에 작성 +# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내) +# '왜'라는 것에 초점을 맞춰 작성 + +################ +# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등) +# 해결 -> Closes(종료), Fixes(수정), Resolves(해결) +# 참고 -> Ref(참고), Related to(관련), See also(참고) +# 예) Close #7 + +################ +# Feat : 새로운 기능 추가 +# Fix : 버그 수정 +# Docs : 문서 수정 +# Test : 테스트 코드, 리팩토링 테스트 코드 추가 +# Refactor : 코드 리팩토링 +# Style : 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)기능 수정이 없는 경우 +# Ci : CI 설정 파일 수정 +# Perf : 성능 개선 +# Chore : 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등) +# Rename : 파일 혹은 폴더명을 수정만 한 경우 +# Remove : 파일을 삭제만 한 경우 +################