Git Usage Rules - boostcampwm-2024/and04-Nature-Album GitHub Wiki

โœ… Git ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ๊ทœ์น™

  • [ํƒ€์ž…๋ช… ๋Œ€๋ฌธ์ž๋กœ ์‹œ์ž‘] ๋ฉ”์„ธ์ง€ ๋‚ด์šฉ
    • ์˜๊ฒฌ ์กฐ์œจ ๊ฒฐ๊ณผ : [Feat]๊ณผ ๊ฐ™์ด ๋Œ€๊ด„ํ˜ธ + ์ฒซ๊ธ€์ž ๋Œ€๋ฌธ์ž๋กœ ํ˜ผํ•ฉํ•˜์—ฌ ์‚ฌ์šฉํ•˜์ž!
    • ๋ฉ”์„ธ์ง€ ๋‚ด์šฉ ํ•œ๊ธ€๋กœ ์ž‘์„ฑ
    • ํŠน์ด์‚ฌํ•ญ or ์ถ”๊ฐ€ ์„ค๋ช… ์ž‘์„ฑ์ด ๋” ํ•„์š”ํ•  ๊ฒฝ์šฐ ๋‚ด์šฉ์— ์ถ”๊ฐ€ ์ž‘์„ฑํ•˜๊ธฐ
  • Commit ํฌ๊ธฐ : ๊ธฐ๋Šฅ ๋‹จ์œ„
ํƒ€์ž… ์ด๋ฆ„ ๋‚ด์šฉ
Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Design xmlํŒŒ์ผ ์ˆ˜์ • ๋ฐ UI ํ…Œ๋งˆ ๊ด€๋ จ ์ž‘์—…
Bugs ๋ฒ„๊ทธ ๋ฐœ์ƒ
Fix ๋ฒ„๊ทธ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Build ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ • / ๋ชจ๋“ˆ ์„ค์น˜ ๋˜๋Š” ์‚ญ์ œ์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Chore ๊ทธ ์™ธ ์ž์ž˜ํ•œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Ci ci ๊ด€๋ จ ์„ค์ • ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Docs ๋ฌธ์„œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Style ์ฝ”๋“œ ์Šคํƒ€์ผ ํ˜น์€ ํฌ๋งท ๋“ฑ์— ๊ด€ํ•œ ์ปค๋ฐ‹
Refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง์— ๋Œ€ํ•œ ์ปค๋ฐ‹, ํŒจํ‚ค์ง€ ์ด๋™
Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Perf ์„ฑ๋Šฅ ๊ฐœ์„ ์— ๋Œ€ํ•œ ์ปค๋ฐ‹

โœ… merge๋ฅผ ์šฐ์„ ์ ์œผ๋กœ ์ง„ํ–‰

  • merge๋ฅผ ์šฐ์„ ์œผ๋กœ ํ•˜๊ณ  rebase๋Š” ํ•„์š”ํ•œ ๊ฒฝ์šฐ์— ์ง„ํ–‰
  • rebaseํ•  ๋•Œ ์™œ ํ•„์š”ํ•œ์ง€ ํŒ€์›์—๊ฒŒ ๋งํ•˜๊ณ  ํ•˜๊ธฐ

โœ… PR ๊ทœ์น™ : ๋ฆฌ๋ทฐ ํ›„ merge

PR โ‡’ ๋ฆฌ๋ทฐ โ‡’ Merge ์ˆœ์„œ๋กœ ์ง„ํ–‰

  • ์ง€๊ธˆ๊นŒ์ง€ ํ•ด์˜จ ๊ฒƒ์ฒ˜๋Ÿผ PR ์ž‘์„ฑ
  • ํŒ€์›๋“ค๊ณผ ํ•จ๊ป˜ ๋ฆฌ๋ทฐ ํ•˜๊ณ  ํ™•์ธ ํ›„ merge ์ง„ํ–‰
  • ์Šค์Šค๋กœ mergeํ•˜์ง€ ๋ง ๊ฒƒ!

PR Merge์˜ ๋งˆ์ง€๋…ธ์„  ์‹œ๊ฐ„

  • ๋”œ๋ ˆ์ด ๋  ๊ฒฝ์šฐ
  • ๋ฐ์ผ๋ฆฌ ์Šคํฌ๋Ÿผ์—์„œ ๋ฐ”๋กœ ๋จธ์ง€ ๋˜๋Š” ๊ฒฝ์šฐโ‡’ ๋จธ์ง€
  • ์ˆ˜์ •์ด ํ•„์š”ํ•  ๊ฒฝ์šฐ ๋‹น์ผ 7์‹œ ์ „๊นŒ์ง€ ์ˆ˜์ • ํ›„ ๋‹ค์‹œ ๋ฆฌ๋ทฐ ํ›„ ๋จธ์ง€

โœ… branch ๊ทœ์น™

PR: feature โ‡’ dev โ‡’ main

  • main : default
  • dev : dev โ‡’ main์œผ๋กœ PR ๋ฆฌ๋ทฐ merge
  • feature โ‡’ dev : PR ํ›„ ๋ฆฌ๋ทฐํ•˜์—ฌ merge
    • feature/ui-deisgn ์ž‘์—… ํ›„ ์™„์„ฑ โ‡’ dev๋กœ PR โ‡’ ๋ฐ์ผ๋ฆฌ ์Šคํฌ๋Ÿผ์—์„œ ํ•จ๊ป˜ ํ™•์ธ ํ›„ merge
  • dev โ‡’ main : PR
    • Minimally Viable Product (MVP) ์™„์„ฑ๋˜๋ฉด dev์—์„œ main์œผ๋กœ PR ํ›„ ํ™•์ธํ•˜์—ฌ MERGE
    • ๋ฒ„์ „ ์—… ๋  ๋•Œ๋งˆ๋‹ค ๋ฆด๋ฆฌ์ฆˆ ์ถ”๊ฐ€ํ•˜๊ธฐ

feature ๋„ค์ด๋ฐ

  • feature/ui-design
    • ํด๋” ๊ตฌ์กฐ๊ฐ€ ์ƒ๊ธฐ๋ฉด ์ข‹์€ ์ ์€?
      • ํ•˜์œ„๋ฅผ ๋ณผ ์ˆ˜ ์žˆ๋‹ค.

โœ… ์—ฌ๋Ÿฌ ์ž‘์„ฑ์ž์™€ ์ปค๋ฐ‹ ๋งŒ๋“ค๊ธฐ

https://docs.github.com/ko/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors

$ git commit -m "Refactor usability tests.
>
>
Co-authored-by: Yujin Jeong <[email protected]>
Co-authored-by: ์ด๋ฆ„ <[email protected]>
Co-authored-by: ์ด๋ฆ„ <๊นƒํ—™๋ฉ”์ผ์ฃผ์†Œ>
Co-authored-by: ์ด๋ฆ„ <๊นƒํ—™๋ฉ”์ผ์ฃผ์†Œ>
Co-authored-by: ์ด๋ฆ„ <๊นƒํ—™๋ฉ”์ผ์ฃผ์†Œ>"

image

โš ๏ธ **GitHub.com Fallback** โš ๏ธ