Skip to content

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

Suhyun Choe edited this page Nov 9, 2023 · 3 revisions

Git Convention - Git Flow

1. Branch ์ „๋žต - Git Flow

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

image

2. Git branch name convention

  • develop์—์„œ [๋ถ„์•ผ]/feature/๊ธฐ๋Šฅ๋ช…์œผ๋กœ ๋ถ„ํ™”

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

3. Git commit convention

  • ์ž‘์—… ์ข…๋ฅ˜: ์ž‘์—… ๋‚ด์šฉ #์ด์Šˆ๋ฒˆํ˜ธ

    e.g.

    feat: login - ๋น„๋ฐ€๋ฒˆํ˜ธ ์œ ํšจ์„ฑ ๊ฒ€์ฆ #12
    <br>
    ์ž‘์—… ๋‚ด์šฉ์„ ์š”์•ฝํ•˜์—ฌ 1~2์ค„ ์ •๋„๋กœ ์ ์–ด์ฃผ์„ธ์š”.
    

    (๊ผฌ๋ฆฌ๋ง์€ ์—†์Œ)

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

4. PR convention

  • PR ํ…œํ”Œ๋ฆฟ์„ ์ค€์ˆ˜ํ•ด ์ž‘์„ฑํ•˜๊ธฐ โญ๏ธ
  • Assignee, Reviewer ์„ ํƒ
    • Assignee๋ฅผ ์ž์‹ , ๊ฐ™์€ ๋ถ„์•ผ ํŒ€์› ๋ชจ๋‘๋ฅผ Reviewer๋กœ ์„ค์ •ํ•˜๊ธฐ
  • Labels: ์•Œ๋งž์€ Label ์„ ํƒ
    • feature / fix / docs / refactor / test / ci/cd / chore
    • ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ : feature
    • ๋ฒ„๊ทธ ์ˆ˜์ • : fix
    • ๊ธฐํƒ€ ๋“ฑ๋“ฑ : chore
  • ๋ธŒ๋žœ์น˜ ์‚ญ์ œ ์ฒดํฌ ์‚ฌํ•ญ ์ฃผ์˜: merge ์‹œ, ๋ธŒ๋žœ์น˜ ์‚ฌ๋ผ์ง€์ง€ ์•Š๋„๋ก ์ฃผ์˜ํ•˜์—ฌ ์‚ดํŽด๋ณผ ๊ฒƒ
Clone this wiki locally