Skip to content

๐ŸŒฑ ์ปจ๋ฒค์…˜

Yoonju Kim edited this page Nov 6, 2023 · 3 revisions

Git Convention - Git Flow

1. Branch ์ „๋žต - Git Flow

  • master : ๋ฐฐํฌ ๋ฒ„์ „์˜ ์†Œ์Šค๊ฐ€ ๋“ค์–ด์žˆ๋Š” ์ตœ์ข… ๋ธŒ๋žœ์น˜
  • develop from master: ๊ฐœ๋ฐœ ๋ฒ„์ „ ์†Œ์Šค
  • fe|be/feature from develop: ๊ธฐ๋Šฅ์„ ๊ฐœ๋ฐœํ•˜๋Š” ๋ธŒ๋žœ์น˜

2. Git branch name convention

  • fe/feature or be/feature์—์„œ ๊ธฐ๋Šฅ ์ด๋ฆ„์œผ๋กœ ๋ถ„ํ™”

    ex. fe/feature-๊ธฐ๋Šฅ๋ช…

3. Git commit convention

  • [jira issue ๋ฒˆํ˜ธ][ํฌ์ง€์…˜-์ด๋ฆ„] ์ž‘์—… ์ข…๋ฅ˜: ์ž‘์—… ๋‚ด์šฉ

    e.g. [S07P12D203-67][FE-์œค์ฃผ] feat: login - ๋น„๋ฐ€๋ฒˆํ˜ธ ์œ ํšจ์„ฑ ๊ฒ€์ฆ
    ํ•œ ์ค„ ๋„๊ณ  ์ž‘์—… ๋‚ด์šฉ์„ ์š”์•ฝํ•˜์—ฌ 1~2์ค„ ์ •๋„๋กœ ์ ์–ด์ฃผ์„ธ์š”.

    • jira issue: ๋Œ€๋ฌธ์ž + ์ˆซ์ž

    • ํฌ์ง€์…˜: FE or BE

    • ์ด๋ฆ„: ํ•œ๊ธ€ ์ด๋ฆ„ (์„ฑ์ œ์™ธ)

    • ์ž‘์—… ์ข…๋ฅ˜

      ย feat : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      ย fix : ๋ฒ„๊ทธ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
       design : CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      ย build : ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      ย chore : ๊ทธ ์™ธ ์ž์ž˜ํ•œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      ย docs : ๋ฌธ์„œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      ย style : ์ฝ”๋“œ ์Šคํƒ€์ผ ํ˜น์€ ํฌ๋งท ๋“ฑ์— ๊ด€ํ•œ ์ปค๋ฐ‹
      ย refactor : ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      ย test : ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      ย ci/cd : CI/CD ๊ด€๋ จ ์„ค์ • ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
      

4. Git Merge convention

  • [ํฌ์ง€์…˜-์ด๋ฆ„] chore: ์ž‘์—… ๋‚ด์šฉ

    e.g. [FE-์œค์ฃผ] chore: user ๊ธฐ๋Šฅ ์ž‘์„ฑ ์™„๋ฃŒ ํ›„ merge

  • Git Merge ํ…œํ”Œ๋ฆฟ์„ ์ค€์ˆ˜ํ•ด ์ž‘์„ฑํ•˜๊ธฐ โญ๏ธ

  • Description์— ๊ธฐ๋Šฅ ๋ฐ ์ˆ˜์ •์‚ฌํ•ญ ์ž‘์„ฑ ํ•„์ˆ˜

    • ๊ด€๋ จ ์ด์Šˆ ๋ฒˆํ˜ธ ์—ฐ๊ฒฐ
  • Assignee, Reviewer ์„ ํƒ

    • Assignee๋ฅผ ์ž์‹ , ๋‚˜๋จธ์ง€ ํŒ€์› ๋ชจ๋‘๋ฅผ Reviewer๋กœ ์„ค์ •ํ•˜๊ธฐ
  • Labels: ์•Œ๋งž์€ Label ์„ ํƒ

    • feature / fix / docs / refactor / test / ci/cd / chore
    • ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ : feature
    • ๋ฒ„๊ทธ ์ˆ˜์ • : fix
    • ๊ธฐํƒ€ ๋“ฑ๋“ฑ : chore
  • ๋ธŒ๋žœ์น˜ ์‚ญ์ œ ์ฒดํฌ ์‚ฌํ•ญ ์ฃผ์˜: merge ์‹œ, ๋ธŒ๋žœ์น˜ ์‚ฌ๋ผ์ง€์ง€ ์•Š๋„๋ก ์ฃผ์˜ํ•˜์—ฌ ์‚ดํŽด๋ณผ ๊ฒƒ

Clone this wiki locally