Commit Convention - GraduationDku/tastyHub GitHub Wiki


Commit Convention


κΉƒ λ ˆν¬μ§€ν† λ¦¬λ₯Ό νŒ€μ›λ“€κ³Ό 같이 μž‘μ—…μ„ μ§„ν–‰ν•  λ•Œ 각자의 κ°€μ§€κ³  있던 컀밋 양식을 ν†΅μΌν•˜κΈ° μœ„ν•΄ 컀밋 μ»¨λ²€μ…˜μ„ μ§€μ •ν•˜κΈ°λ‘œ ν–ˆλ‹€. μ§€μ •λœ 컀밋 μ»¨λ²€μ…˜μ€ λ‹€μŒκ³Ό κ°™λ‹€. ν•΄λ‹Ή κ·œμΉ™μ„ κΈ°μ€€μœΌλ‘œ 컀밋을 μž‘μ„±ν•˜κΈ°λ‘œ ν•˜μ˜€μœΌλ©° 이λ₯Ό 톡해 컀밋 관리λ₯Ό μ§„ν–‰ν•˜λ €κ³  ν•œλ‹€. 컀밋 μ»¨λ²€μ…˜μ„ 톡해 μ–»κ³ μžν•˜λŠ” 것은 λ‹€μŒκ³Ό κ°™λ‹€.

  1. μ§€μ •λœ 컀밋 양식을 ν†΅ν•œ 컀밋 ν˜•μ‹ 톡일화
  2. 이슈번호 #n을 μ§€μ •ν•˜μ—¬ ν•΄λ‹Ή μ΄μŠˆμ™€ κ΄€λ ¨λœ μ–΄λ–€ μž‘μ—…μ„ μ§„ν–‰ν•˜μ˜€λŠ”μ§€ νŒŒμ•…
  3. μ§„ν–‰λœ 컀밋 및 μ»€λ°‹μ˜ μ˜΅μ…˜μ„ 톡해 μ»€λ°‹μ˜ μž‘μ—… λ‚΄μš©μ„ μ§κ΄€μ μœΌλ‘œ νŒŒμ•…

Commit & Type Option


type(<scope>): <subject>  -- 헀더(ν•„μˆ˜) // μ£Όμ œλŠ” 50자 μ΄ν•˜,μˆ˜ν–‰ν•œ μž‘μ—…μ— λŒ€ν•΄ λͺ…λ Ήν˜• μž‘μ„±
 
<body>                    -- λ³Έλ¬Έ(μ˜΅μ…˜) // 컀밋이 μ„€λͺ… 및 문단이 ν•„μš”ν•  λ•Œ μ‚¬μš©

<footer>                  -- λ°”λ‹₯κΈ€(μ˜΅μ…˜) // μ˜΅μ…˜ 및 이슈의 아이디λ₯Ό μ‚¬μš©
fix(<Like>): μ‹«μ–΄μš” 음수둜 λ‚΄λ €κ°€λŠ” 였λ₯˜ μˆ˜μ •

μ’‹μ•„μš”&μ‹«μ–΄μš” λ²ˆκ°ˆμ•„κ°€λ©° ν΄λ¦­μ‹œ 음수둜 λ‚΄λ €κ°€λŠ” 였λ₯˜ μˆ˜μ •.
μ’‹μ•„μš”λŠ” 이상 μ—†μŒ.

Resolves: #13 (이슈번호)

νƒ€μž…μ— λ“€μ–΄κ°€λŠ” μ˜΅μ…˜μ€ λ‹€μŒκ³Ό 같이 9개둜 κ΅¬μ„±λ˜μ–΄μžˆλ‹€.

  • feat : μƒˆλ‘œμš΄ κΈ°λŠ₯
  • fix : 버그 μˆ˜μ •
  • docs : λ¬Έμ„œ μˆ˜μ •
  • style : μ½”λ“œ μŠ€νƒ€μΌ ν˜Ήμ€ 포맷 등에 κ΄€ν•΄μ„œ.. μ½”λ“œμ˜ λ³€κ²½X
  • refactor : μ½”λ“œ λ¦¬νŒ©ν† λ§
  • test : ν…ŒμŠ€νŠΈ μ½”λ“œ μΆ”κ°€ ν˜Ήμ€ λ¦¬νŒ©ν† λ§.. μ½”λ“œμ˜ λ³€κ²½X
  • chore : κ·Έ μ™Έ μžμž˜ν•œ μˆ˜μ •(νŒ¨ν‚€μ§€ λ§€λ‹ˆμ € ꡬ성, λΉŒλ“œ μž‘μ—… μ—…λ°μ΄νŠΈ).. μ½”λ“œμ˜ λ³€κ²½X
  • build : λΉŒλ“œ κ΄€λ ¨ 파일 μˆ˜μ •
  • ci : CIκ΄€λ ¨ μ„€μ • μˆ˜μ •
⚠️ **GitHub.com Fallback** ⚠️