Skip to content

๐Ÿ“ Git Convention

Chaebum edited this page Oct 25, 2021 · 3 revisions

Branch Strategy

  • develop branch๋ฅผ ๋กœ์ปฌ๋กœ pullํ•œ ํ›„ feature/example branch ์ƒ์„ฑ.
  • ๋งŒ์•ฝ ํ•œ feature๋ฅผ ์—ฌ๋Ÿฌ๋ช…์ด ๋‹ด๋‹นํ•˜๋ฉด, feature์—์„œ ๋‹ค์‹œ ๊ฐ์ž ์•„์ด๋””(ex.J010)๋กœ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ, feature์— ํ†ตํ•ฉํ•œ ํ›„์— PR ๋ณด๋‚ด๊ธฐ.
  • PR๋ณด๋‚ผ ๋•Œ ๋ฆฌ๋ทฐ์–ด ์ง€์ •ํ•ด์„œ ๋ฆฌ๋ทฐํ•˜๊ณ , Rebase And Mergeํ•˜๊ธฐ.
  • feature์—์„œ ์ถฉ๋Œ ๋ฐœ์ƒ ์‹œ local์—์„œ ์ˆ˜์ • ํ›„ merge.

PR Convention

  1. 1์ผ 1PR ์ด์ƒ ์„ ๋ชฉํ‘œ๋กœ ํ•œ๋‹ค.
  2. PR์ด ์˜ฌ๋ผ์˜ค๋ฉด, ์ง€์ •๋œ ๋ฆฌ๋ทฐ์–ด 2๋ช…์ด ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋ฅผ ์ง„ํ–‰ํ•œ๋‹ค.
  3. ๋ฌธ์ œ๊ฐ€ ์—†๋‹ค๋ฉด, Rebase And Mergeํ•œ๋‹ค.

Commit Convention

# [ํƒ€์ž…] ์ œ๋ชฉ ์ตœ๋Œ€ 50๊ธ€์ž 
# โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”
#   [Feat] ๊ธฐ๋Šฅ (์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ)  
#   [Fix] ๋ฒ„๊ทธ (๋ฒ„๊ทธ ์ˆ˜์ •) 
#   [Refactor] ๋ฆฌํŒฉํ† ๋ง
#   [Style] ์Šคํƒ€์ผ (์ฝ”๋“œ ํ˜•์‹, ์„ธ๋ฏธ์ฝœ๋ก  ์ถ”๊ฐ€: ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์— ๋ณ€๊ฒฝ ์—†์Œ)
#   [Docs] ๋ฌธ์„œ (๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ)
#   [Chore] ๊ธฐํƒ€ ๋ณ€๊ฒฝ์‚ฌํ•ญ (๋นŒ๋“œ ์Šคํฌ๋ฆฝํŠธ ์ˆ˜์ • ๋“ฑ) 
#   [Test] ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
# โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”

# ๋ณธ๋ฌธ(์ถ”๊ฐ€ ์„ค๋ช…)์„ ์•„๋žซ์ค„์— ์ž‘์„ฑ
# โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”
#   ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์€ ํ•œ๊ตญ์–ด
#   ์ œ๋ชฉ์€ ๋ช…๋ น์–ด๋กœ ์ž‘์„ฑ
#   ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.) ๊ธˆ์ง€
#   ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ํ•œ ์ค„ ๋„์›Œ ๋ถ„๋ฆฌํ•˜๊ธฐ
#   ๋ณธ๋ฌธ์€ โ€œ์–ด๋–ป๊ฒŒโ€ ๋ณด๋‹ค โ€œ๋ฌด์—‡์„โ€œ, โ€œ์™œโ€๋ฅผ ์„ค๋ช…ํ•œ๋‹ค.
# โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”โ€”

# ๊ผฌ๋ฆฟ๋ง(footer)์„ ์•„๋žซ์ค„์— ์ž‘์„ฑ #์ด์Šˆ๋ฒˆํ˜ธ

Issue Convention

Issue Label

#a228ef ์Šคํƒ€์ผ
#a2eeef ๊ธฐ๋Šฅ
#e99695 ํ”„๋ก ํŠธ์—”๋“œ
#64EB8A ๋ฐฑ์—”๋“œ
#e4e669 ๋ฆฌํŒฉํ† ๋ง
#d73a4a ๋ฒ„๊ทธ
#456356 ์„ธํŒ…

Issue Template

## ๋ชฉ์ 

## ์ž‘์—… ๋‚ด์šฉ
- [ ]

## ์ฃผ์˜์‚ฌํ•ญ

Reference

[GitHub] PR ํ…œํ”Œ๋ฆฟ, ์ด์Šˆ ํ…œํ”Œ๋ฆฟ ๋“ฑ๋กํ•˜๊ธฐ (Pull Request Template, Issue Template)