Skip to content

๐Ÿ›  Convention

Lee EunSeong edited this page Feb 24, 2023 · 5 revisions

Commit Convention

feat : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
fix : ๋ฒ„๊ทธ ์ˆ˜์ •
docs : ๋ฌธ์„œ ์ˆ˜์ •
style : ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ
refactor : ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง
test : ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
chore : ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •

{type}: {message}(#{issue_num})
  • type: ์œ„์— ์žˆ๋Š” ์œ ํ˜•์œผ๋กœ๋งŒ
  • message: ํ•œ๊ธ€

Branch Convention

main : ๋ฆด๋ฆฌ์ฆˆ ๋ธŒ๋žœ์น˜
dev : ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜(main ์ „ ๋ฐฐํฌ๋ฅผ ๋‚˜๊ฐ€๋„ ๋˜๋Š” ๋ฌธ์ œ ์—†๋Š” ๋ธŒ๋žœ์น˜)
staging : ํ…Œ์ŠคํŠธ ๋ธŒ๋žœ์น˜

  • {type}/#{issue_num} : ์ด์Šˆ ๋ธŒ๋žœ์น˜
{type}/#{issue_num}

PR Rules

  1. ์ด์Šˆ ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—… ํ›„ dev๋กœ PR ์š”์ฒญ
  2. 1๋ช… ์ด์ƒ approve ํ•ด์•ผ PR ์Šน์ธ

merge Rules

  1. issue branch -> dev ์‹œ์—๋Š” PR๋กœ fast forward merge
  2. dev -> main ์‹œ์—๋Š” commit merge(๋ฐฐํฌ ์‹œ ๋…ผ์˜)
Clone this wiki locally