branch, issue, commit message - sihyun10/pintos-lab GitHub Wiki

branch ๊ด€๋ฆฌ ๊ทœ์น™

  • ๊ฐ์ž์˜ ๋ธŒ๋žœ์น˜๋ฅผ ๋”ฐ๋กœ ๋งŒ๋“ ๋‹ค.
    ๊ฐ์ž ์ž‘์—…ํ•œ ๋ถ€๋ถ„์„ ๊ฐ์ž์˜ ๋ธŒ๋žœ์น˜์— push โž” pull requestํ•˜๊ณ  ๋‚จ์€ 2๋ช…์˜ ์Šน์ธ ํ›„์— merge

๐Ÿ”— branch naming convention

  • ํ˜•์‹ : week{์ฃผ์ฐจ}-{์ด๋‹ˆ์…œ}-{์ž‘์—…๋ฒˆํ˜ธ}
  • ์˜ˆ์‹œ : week09-sha-01

Workflow

  1. Issue Creation
    ์ฃผ์ฐจ๋ณ„ ์š”๊ตฌ์‚ฌํ•ญ์— ๋”ฐ๋ผ ๊ฐœ๋ณ„ ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•œ๋‹ค.
    commit์„ ํ• ๋•Œ, issue ๋ฒˆํ˜ธ๋„ ํ•จ๊ป˜ ์ž‘์„ฑํ•ด์ค€๋‹ค.

  2. Branch Creation
    ๋„ค์ด๋ฐ ๊ทœ์น™(week{์ฃผ์ฐจ}-{์ด๋‹ˆ์…œ}-{์ž‘์—…๋ฒˆํ˜ธ})์— ๋”ฐ๋ผ ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑํ•˜๊ณ  ๊ตฌํ˜„์„ ์‹œ์ž‘ํ•œ๋‹ค.

  3. Pull Request
    ์ž‘์—…์ด ์™„๋ฃŒ๋˜๋ฉด main ๋ธŒ๋žœ์น˜๋ฅผ ๋Œ€์ƒ์œผ๋กœ PR์„ ์—ฐ๋‹ค.

  4. Code Review
    ๋ชจ๋“  ํŒ€์›์ด PR์„ ๊ฒ€ํ† ํ•˜๊ณ , ํ”ผ๋“œ๋ฐฑ์ด๋‚˜ ๊ฐœ์„  ์š”์ฒญ์„ ๋Œ“๊ธ€๋กœ ๋‚จ๊ธด๋‹ค.

  5. Approval
    ์ตœ์†Œ 2๋ช… ์ด์ƒ์˜ ํŒ€์›์ด PR์„ ์Šน์ธํ•œ๋‹ค.

  6. Merge
    ์Šน์ธ์ด ์™„๋ฃŒ๋˜๋ฉด ํŒ€์ด ๋ชจ์—ฌ ์ตœ์ข…์ ์œผ๋กœ PR์„ ๋Œ€์ƒ ๋ธŒ๋žœ์น˜์— merge ์‹œํ‚จ๋‹ค.


Commit ๋ฉ”์‹œ์ง€ ์ปจ๋ฒค์…˜

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