Skip to content

Commit d19ae3e

Browse files
authored
Merge pull request #2 from billilge/init/#1-git-template-setting
[Init/#1] Issue, PR 템플릿 추가
2 parents bee835a + dac32c9 commit d19ae3e

File tree

4 files changed

+153
-0
lines changed

4 files changed

+153
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: "버그 수정"
2+
description: 버그 수정 사항을 작성해주세요.
3+
title: "[ Bug ] "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
작성 예시 : "[ Bug ] 로그인 기능 버그 수정"
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: 🐛 Issue
13+
description: 버그가 발생한 이슈 이름과 번호를 작성해주세요.
14+
placeholder: "[ Feat ] 로그인 기능 구현 <#1>"
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: textarea_description
19+
attributes:
20+
label: 🐝 버그 발생 부분
21+
description: 버그가 발생한 부분을 작성해주세요.
22+
placeholder: |
23+
1. <버그 설명 1>
24+
2. <버그 설명 2>
25+
render: ""
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: fix-list
30+
attributes:
31+
label: 📝 To-do
32+
description: 작업에 필요한 목록을 작성해주세요.
33+
placeholder: 목록을 작성해주세요.
34+
validations:
35+
required: true

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: "기능 추가"
2+
description: 기능 추가 작업 사항을 작성해주세요.
3+
title: "[ Feat ] "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
작성 예시 : "[ Feat ] 로그인 기능 구현"
9+
- type: textarea
10+
id: feat-description
11+
attributes:
12+
label: 🛠 Issue
13+
description: 어떠한 기능을 추가하시는 건지 작성해주세요.
14+
placeholder: 설명을 작성해주세요.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: feat-list
19+
attributes:
20+
label: 📝 To-do
21+
description: 작업에 필요한 목록을 작성해주세요.
22+
placeholder: 목록을 작성해주세요.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: reproduction
27+
attributes:
28+
label: 🔍 접근 방법
29+
description: 고려하신 방법이나, 접근에 대해서 설명해주세요.
30+
placeholder: 설명을 작성해주세요.
31+
validations:
32+
required: true
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "리팩토링"
2+
description: 리팩토링 작업 사항을 작성해주세요.
3+
title: "[ Refactor ] "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
작성 예시 : "[ Refactor ] 로그인 기능 리팩토링"
9+
- type: textarea
10+
id: refactor-description
11+
attributes:
12+
label: ♻️ Issue
13+
description: 어떠한 기능을 리팩토링하시는 건지 작성해주세요.
14+
placeholder: 설명을 작성해주세요.
15+
validations:
16+
required: true
17+
- type: input
18+
id: input_parent
19+
attributes:
20+
label: 🔢 리팩토링하는 이슈를 기입해주세요.
21+
description: 리팩토링을 진행하는 이전 이슈를 작성해주세요.
22+
placeholder: "#이슈번호"
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: textarea_description
27+
attributes:
28+
label: 📣 리팩토링 목적
29+
description: 리팩토링 목적을 작성해주세요.
30+
placeholder: |
31+
1. 이유
32+
2. 이유
33+
render: ""
34+
validations:
35+
required: false
36+
- type: textarea
37+
id: refactor-list
38+
attributes:
39+
label: 📝 To-do
40+
description: 작업에 필요한 목록을 작성해주세요.
41+
placeholder: 목록을 작성해주세요.
42+
validations:
43+
required: true

.github/pull_request_template.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!-- PR의 제목은 "[Feat/#1] 로그인 기능 추가" 와 같이 작성해주세요! -->
2+
3+
## 📌 관련 이슈번호
4+
5+
<!-- Closes 키워드가 있어야 PR이 머지되었을 때 이슈가 자동으로 닫힙니다. -->
6+
7+
- Closes #
8+
9+
## 🎟️ PR 유형
10+
11+
어떤 변경 사항이 있나요?
12+
13+
- [ ] 새 기능 추가
14+
- [ ] 버그 수정
15+
- [ ] CSS 등 사용자 UI 디자인 변경
16+
- [ ] 리팩토링
17+
18+
## Check List
19+
20+
- [ ] 🔀 PR 제목의 형식을 잘 작성했나요?
21+
- [ ] 🏗️ yarn build는 성공했나요?
22+
- [ ] 🧹 불필요한 코드는 제거했나요? (TODO, 주석, clg... etc.)
23+
- [ ] ✅ 컨벤션을 지켰나요?
24+
- [ ] 💭 이슈는 등록했나요?
25+
- [ ] 🏷️ 라벨은 등록했나요?
26+
- [ ] 🙇‍♂️ 리뷰어를 지정했나요?
27+
28+
## ✅ Key Changes
29+
30+
> 이번 PR에서 작업한 내용을 간략히 설명해주세요
31+
1. 작업 내용
32+
33+
## 📢 To Reviewers
34+
35+
-
36+
37+
## 📸 스크린샷
38+
39+
<!-- 이해하기 쉽도록 스크린샷을 첨부해주세요. -->
40+
41+
## 🔗 참고 자료
42+
43+
<!-- 참고 레퍼런스를 첨부해주세요. -->

0 commit comments

Comments
 (0)