Skip to content

Commit

Permalink
Docs: 템플릿 추가
Browse files Browse the repository at this point in the history
- 일관성 있는 협업을 위해 PR/버그/이슈/커밋 템플릿 추가
Related to #1
  • Loading branch information
Zamoca42 committed Oct 25, 2023
1 parent 61778d4 commit 0224ce0
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug template
about: 버그 발생 시 사용하는 템플릿입니다
title: "버그 리포트"
labels: "bug"
assignees:

---

## 버그에 대한 설명
버그가 무엇인지 명확하고 간결하게 설명합니다.

## 재현 방법
어떤 식으로 발생했는지 순서대로 작성해주세요:
1. 어디를 가서 '....'
2. 어떤 행동을 했더니 '...'
3. 에러가 나왔다 ' ... '

## 예상 동작
발생할 것으로 예상한 사항에 대한 명확하고 간결한 설명.

## 스크린샷
해당하는 경우 스크린샷을 추가하여 문제를 설명.


## 추가 내용
여기에 문제에 대한 다른 내용을 추가합니다.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Issue template
about: 이슈 작성 시 사용하는 템플릿입니다
title: "이슈 리포트"
labels: ""
assignees:

---

## 이슈 내용
> 이슈 내용 작성
<br>

## 작업 사항
- [ ] 해당 이슈의 작업사항

<br>

## 관련 이슈
- #이슈 번호

<br>

## 기타사항


<br>
37 changes: 37 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## PR 체크리스트
아래 항목을 확인해 주세요:

- [ ] 커밋 메시지가 우리의 가이드라인을 따르고 있는지 확인하세요
- [ ] 변경 사항에 대한 테스트가 추가되었는지 확인하세요 (버그 수정 / 기능 추가)
- [ ] 문서가 추가되거나 업데이트되었는지 확인하세요 (버그 수정 / 기능 추가)

## PR 유형
이 PR은 어떤 종류의 변경을 가져오나요?

<!-- 이 PR에 해당하는 것을 "x"로 표시하세요. -->

- [ ] 버그 수정
- [ ] 새로운 기능 추가
- [ ] 코드 스타일 업데이트 (서식, 로컬 변수)
- [ ] 리팩터링 (기능 변경 없음, API 변경 없음)
- [ ] 빌드 관련 변경
- [ ] CI 관련 변경
- [ ] 문서 내용 변경
- [ ] 애플리케이션 / 인프라 변경
- [ ] 기타... 설명:

## 현재 동작은 무엇인가요?
<!-- 수정 중인 현재 동작을 설명하거나 관련된 이슈에 링크하세요. -->

이슈 번호: N/A

## 새로운 동작은 무엇인가요?

## 이 PR은 호환성 변경을 도입하나요?

- [ ]
- [ ] 아니요

<!-- 이 PR에 호환성 변경이 포함되어 있다면, 기존 응용 프로그램에 대한 영향과 마이그레이션 경로를 아래에 설명해 주세요. -->

## 기타 정보
31 changes: 31 additions & 0 deletions .gitmessage.txt
Original file line number Diff line number Diff line change
@@ -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 : 파일을 삭제만 한 경우
################

0 comments on commit 0224ce0

Please sign in to comment.