Skip to content

Conventions

Ahrim Yang edited this page Nov 16, 2020 · 2 revisions

commit

# <ํƒ€์ž…>: <์ œ๋ชฉ>
##### ์ œ๋ชฉ์€ ์ตœ๋Œ€ 50 ๊ธ€์ž๊นŒ์ง€๋งŒ ์ž…๋ ฅ ############## -> |

# ๋ณธ๋ฌธ์€ ์•„๋ž˜์— ์ž‘์„ฑ
######## ๋ณธ๋ฌธ์€ ํ•œ ์ค„์— ์ตœ๋Œ€ 72 ๊ธ€์ž๊นŒ์ง€๋งŒ ์ž…๋ ฅ ########################### -> |

# ๊ผฌ๋ฆฟ๋ง์€ ์•„๋ž˜์— ์ž‘์„ฑ: ex) #์ด์Šˆ ๋ฒˆํ˜ธ

# --- COMMIT END ---
# <ํƒ€์ž…> ๋ฆฌ์ŠคํŠธ
#   feat    : ๊ธฐ๋Šฅ (์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ)
#   fix     : ๋ฒ„๊ทธ (๋ฒ„๊ทธ ์ˆ˜์ •)
#   refactor: ๋ฆฌํŒฉํ† ๋ง
#   style   : ์Šคํƒ€์ผ (์ฝ”๋“œ ํ˜•์‹, ์„ธ๋ฏธ์ฝœ๋ก  ์ถ”๊ฐ€: ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์— ๋ณ€๊ฒฝ ์—†์Œ)
#   docs    : ๋ฌธ์„œ (๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ)
#   test    : ํ…Œ์ŠคํŠธ (ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ: ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์— ๋ณ€๊ฒฝ ์—†์Œ)
#   chore   : ๊ธฐํƒ€ ๋ณ€๊ฒฝ์‚ฌํ•ญ (๋นŒ๋“œ ์Šคํฌ๋ฆฝํŠธ ์ˆ˜์ • ๋“ฑ)
# ------------------
#     ํ•œ๊ธ€๋กœ!
#     ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.) ๊ธˆ์ง€
#     ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ํ•œ ์ค„ ๋„์›Œ ๋ถ„๋ฆฌํ•˜๊ธฐ
#     ๋ณธ๋ฌธ์€ "์–ด๋–ป๊ฒŒ" ๋ณด๋‹ค "๋ฌด์—‡์„", "์™œ"๋ฅผ ์„ค๋ช…ํ•œ๋‹ค.
#     ๋ณธ๋ฌธ์— ์—ฌ๋Ÿฌ์ค„์˜ ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•  ๋• "-"๋กœ ๊ตฌ๋ถ„
# ------------------

template ์ ์šฉ ๋ฐฉ๋ฒ•

PR

## ๊ฐœ์š”
## ์ž‘์—…์‚ฌํ•ญ
## ๊ธฐํƒ€
  • PR, Issue์— assignee, label ๋“ฑ tag

template ์ ์šฉ ๋ฐฉ๋ฒ•

Issue

### ๐Ÿ“Œ To Do 
- [ ] ํ•  ์ผ1
- [ ] ํ•  ์ผ2
### ๐Ÿ‘‰ Problem 
- ํ˜„์žฌ์˜ ๋ฌธ์ œ

### ๐Ÿ€ Solution
- ํ•ด๊ฒฐ ๋ฐฉ์•ˆ

### ๐Ÿ‘Š So We
- ๊ทธ๋ž˜์„œ ์šฐ๋ฆฌ๋Š” ์ด๋ ‡๊ฒŒ ํ•˜์ž

template ์ ์šฉ ๋ฐฉ๋ฒ•

Clone this wiki locally