Programming Language/Java

Commit convention 지킀기 (feat. Angular.js)

rmsidgkrl 2021. 11. 24. 10:43
728x90
λ°˜μ‘ν˜•

 

πŸ“Œ μ»€λ°‹ 메세지 ꡬ쑰 (Commit Message Structure)

  • 바디와 ν’‹ν„° 뢀뢄은 μƒλž΅ κ°€λŠ₯ν•˜λ‹€. λ°”λ””λŠ” λΆ€μ—° μ„€λͺ…이 ν•„μš”ν•œ 경우, ν’‹ν„°λŠ” 이슈 번호 등을 μž‘μ„±ν•  λ•Œ ν™œμš©ν•œλ‹€.
<type(scope)>: subject summary     -> 컀밋메세지 헀더
<blank line>
body                               -> 컀밋메세지 λ°”λ””
<blank line>
footer                             -> 컀밋메세지 ν’‹ν„°

 

πŸ“„μ»€λ°‹ 메세지 헀더(Commit Message Header)

 

<type>에 λ“€μ–΄κ°ˆ 수 μžˆλŠ” ν•­λͺ©

feat(feature) : μƒˆλ‘œμš΄ κΈ°λŠ₯ μΆ”κ°€
fix(bug fix) : 버그 μˆ˜μ •
docs(documentation) : λ¬Έμ„œ μž‘μ—…
style(formatting, missing semi colons) : μ½”λ“œ ν¬λ§·νŒ…, μ½”λ“œ 변경이 μ—†λŠ” 경우
refactor : μ½”λ“œ λ¦¬νŒ©ν† λ§
test(when adding missing test) : ν…ŒμŠ€νŠΈ μ½”λ“œ
build: λΉŒλ“œ κ΄€λ € 파일 μˆ˜μ •
chore : κ·Έ μ™Έ μžμž˜ν•œ μˆ˜μ •

 

 

πŸ‘©‍🏫 bashμ°½μ—μ„œ commit 메세지 μž‘μ„±ν•˜λŠ” 방법

 

git bashμ—μ„œ 컀밋 메세지λ₯Ό μž‘μ„±ν•  λ•Œ git commit λͺ…λ Ήμ–΄λ₯Ό 치면 μ•„λž˜μ™€ 같이 vi에디터가 μ‹€ν–‰λœλ‹€.  s λ₯Ό 눌러 insert λͺ¨λ“œλ‘œ λ³€κ²½ ν›„ 컀밋 메세지λ₯Ό μž‘μ„±ν•˜λ©΄ 되고 μž‘μ„±μ„ 끝낸후 :wq  λ₯Ό 눌러 λ³€κ²½ν•œ λ‚΄μš©μ„ μ €μž₯ν•˜λ©΄ λœλ‹€.

 

맨 μœ—μ€„μ— 컀밋메세지 헀더λ₯Ό μž‘μ„±ν•˜κ³  ν•œμ€„ 띄고 λ°”λ””, ν•œμ€„ 띄고 ν’‹ν„°λ₯Ό μˆœμ„œλŒ€λ‘œ μž‘μ„±ν•˜λ©΄ λœλ‹€. μ»€λ°‹λ©”μ„Έμ§€μ˜ 헀더, λ°”λ””, ν’‹ν„°λ₯Ό κ΅¬λΆ„ν•˜λŠ” 기쀀은 blank line ν•œμ€„ λ„μš°λŠ” 것이닀.

 

μ•„λž˜λŠ” ν•˜λ‚˜μ˜ μ˜ˆμ‹œλ‹€. μ»€λ°‹ν•˜κ³  푸쉬 ν›„ κΉƒν—™μ—μ„œ 컀밋 νžˆμŠ€ν† λ¦¬λ₯Ό 찾아보면 컀밋 헀더, λ°”λ””, ν’‹ν„°κ°€  ν•œμ€„μ”© ν‘œν˜„λ˜λŠ” 것을 확인할 수 μžˆλ‹€. 

 

λ°˜μ‘ν˜•