Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feat] Create Issue & PR template #108

Merged
merged 5 commits into from
Feb 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: ๐Ÿ’ก feature
about: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
title: "[feat] New feature"
labels: feature
---

## ๐Ÿ’ก New Feature
์ƒˆ๋กญ๊ฒŒ ์ถ”๊ฐ€ํ•  ๊ธฐ๋Šฅ์— ๋Œ€ํ•ด ์†Œ๊ฐœํ•ด์ฃผ์„ธ์š”.

## ๐Ÿ“ To Do
- [ ] ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ A ์ถ”๊ฐ€
- [ ] ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ B ์ถ”๊ฐ€
- [ ] ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘์„ฑ

## โœ… Issue check list
1. Assignees, Labels ํ™•์ธํ•˜๊ธฐ
2. Milestone ์—ฐ๊ฒฐ ํ™•์ธํ•˜๊ธฐ
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: ๐Ÿž fix
about: ์˜ค์ž‘๋™ ์ฝ”๋“œ ๋ฐ”๋กœ์žก๊ธฐ
title: "[fix] Change description"
labels: fix
---

## ๐Ÿž Change
ํ˜„์žฌ์˜ ์ž˜๋ชป๋˜๊ณ  ์žˆ๋Š” ์ ์— ๋Œ€ํ•œ ์„ค๋ช…๊ณผ ์ˆ˜์ • ํ›„ ์˜ˆ์ƒ ๋ณ€ํ™”์— ๋Œ€ํ•ด ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”.

## ๐Ÿ“ To Do
- [ ] logic A ๋ณ€๊ฒฝ
- [ ] logic B ๋ณ€๊ฒฝ

## โœ… Issue check list
1. Assignees, Labels ํ™•์ธํ•˜๊ธฐ
2. Milestone ์—ฐ๊ฒฐ ํ™•์ธํ•˜๊ธฐ
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: ๐Ÿง refactor
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

์•„์˜ค ใ…‹ใ…‹

about: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
title: "[refactor] Refactor object"
labels: refactor
---

## ๐Ÿง Refactoring Target
ํ•ด๋‹น ๋ฆฌํŒฉํ† ๋ง์˜ ๋Œ€์ƒ๊ณผ ๋ชฉ์ ์„ ์š”์•ฝํ•ด ์ ์–ด์ฃผ์„ธ์š”.

## ๐Ÿ“ To Do
- [ ] file A ๋ฆฌํŒฉํ† ๋ง
- [ ] file B ๋ฆฌํŒฉํ† ๋ง

## โœ… Issue check list
1. Assignees, Labels ํ™•์ธํ•˜๊ธฐ
2. Milestone ์—ฐ๊ฒฐ ํ™•์ธํ•˜๊ธฐ
33 changes: 21 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
### โœ… PR check list
- [ ] commit message๊ฐ€ ์ ์ ˆํ•œ์ง€ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
- [ ] ๋งˆ์ง€๋ง‰์œผ๋กœ Coding Convention์„ ์ค€์ˆ˜ํ–ˆ๋Š”์ง€ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
- [ ] ์ ์ ˆํ•œ branch๋กœ ์š”์ฒญํ–ˆ๋Š”์ง€ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
- [ ] Assignees, Label์„ ๋ถ™์—ฌ์ฃผ์„ธ์š”.
- [ ] ๊ฐ€๋Šฅํ•œ ์ด์Šˆ๋ฅผ Link ํ•ด์ฃผ์„ธ์š”.
- [ ] PR์ด ์Šน์ธ๋œ ๊ฒฝ์šฐ ํ•ด๋‹น ๋ธŒ๋žœ์น˜๋Š” ์‚ญ์ œ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค.
## ๐ŸŒˆ PR ์š”์•ฝ / Linked Issue
ํ•ด๋‹น PR์—์„œ ์ž‘์—…ํ•œ ๋‚ด์šฉ์„ ํ•œ ์ค„๋กœ ์š”์•ฝํ•ด์ฃผ์„ธ์š”.
close #{no}

## ๐ŸŒˆ PR ์š”์•ฝ
ํ•ด๋‹น pr์—์„œ ์ž‘์—…ํ•œ ๋‚ด์—ญ์„ ์ ์–ด์ฃผ์„ธ์š”.

## ๐Ÿ“Œ ๋ณ€๊ฒฝ ์‚ฌํ•ญ
๋ณ€๊ฒฝ์‚ฌํ•ญ ๋ฐ ์ฃผ์˜ ์‚ฌํ•ญ (๋ชจ๋“ˆ ์„ค์น˜ ๋“ฑ)์„ ์ ์–ด์ฃผ์„ธ์š”.
๋””ํ…Œ์ผํ•œ ์ž‘์—… ๋‚ด์—ญ์„ ์ ์–ด์ฃผ์„ธ์š”.
์ฃผ์˜ํ•  ์‚ฌํ•ญ์ด ์žˆ๋‹ค๋ฉด ์ ์–ด์ฃผ์„ธ์š”.
๋ณ€๊ฒฝ์‚ฌํ•ญ (๋ชจ๋“ˆ ์„ค์น˜ ๋“ฑ)์ด ์žˆ๋‹ค๋ฉด ์ ์–ด์ฃผ์„ธ์š”.


## โœ… PR check list
### 1. ์ œ๋ชฉ ์–‘์‹ ์ค€์ˆ˜ ํ™•์ธ
[feat] PR title

### 2. ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘๋™ ์Šคํฌ๋ฆฐ์ƒท
`npm run mocha`


## โœ… After merge check list
### 1. ๋ฆด๋ฆฌ์ฆˆ ๋…ธํŠธ ๋ณ€๊ฒฝ
[๋ฆด๋ฆฌ์ฆˆ ๋…ธํŠธ](https://www.notion.so/2c17ef784e684d94a51e3c23f4e7c814) To Do์—์„œ Done์œผ๋กœ ์˜ฎ๊ธฐ๊ธฐ

### 2. ๋ธŒ๋žœ์น˜ ์‚ญ์ œ

#### Linked Issue
close `#Issue number`
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,6 @@ out
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
.pnp.*

.idea/