04. Commit Style Guide - zmd9220/Aksoo GitHub Wiki

Commit Style Guide

1. Commit Message Structure

๊ธฐ๋ณธ์ ์œผ๋กœ ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€๋Š” ์•„๋ž˜์™€ ๊ฐ™์ด ์ œ๋ชฉ/๋ณธ๋ฌธ/๊ผฌ๋ฆฌ๋ง๋กœ ๊ตฌ์„ฑํ•œ๋‹ค.

์ง€๋ผ์ด์Šˆ๋ฒˆํ˜ธ [TYPE] ์ œ๋ชฉ 

body

footer

์˜ˆ)

$ git commit -m "์ง€๋ผ๋ฒˆํ˜ธ [TYPE] : ์ด์Šˆ ๊ด€๋ จ ๋‚ด์šฉ"

ex> S05P13B201-338 [ADD] : ์‹œ์—ฐ ์ค€๋น„๋ฅผ ์œ„ํ•ด ๊ฒฐ์ œ ์™„๋ฃŒ ํŽ˜์ด์ง€ ๊พธ๋ฏธ๊ธฐ

2. Types of commit

์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ์ปค๋ฐ‹ ํƒ€์ž…์€ ๋‹ค์Œ๊ณผ ๊ฐ™๋‹ค.

  • ADD : ์ƒˆ๋กœ์šด ์ฝ”๋“œ ์ถ”๊ฐ€
  • MODIFY : ์ฝ”๋“œ ์ˆ˜์ •
  • FIX : ๋ฒ„๊ทธ ์ˆ˜์ •
  • DOCS : ๋ฌธ์„œ ์ˆ˜์ • (README.md, WIKI)
  • MERGE : ๋ธŒ๋žœ์น˜ ๋ณ‘ํ•ฉ
  • REFACTOR : ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
  • STYLE : ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ
  • TEST : ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
  • CHORE : ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ๊ธฐํƒ€ ๋ณ€๊ฒฝ์‚ฌํ•ญ, ๋‹ค๋ฅธ ๋ชฉ์ 

์ฐธ๊ณ ๋ฌธ์„œ

Git - ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์ปจ๋ฒค์…˜

์ข‹์€ git ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•˜๊ธฐ ์œ„ํ•œ 7๊ฐ€์ง€ ์•ฝ์† : NHN Cloud Meetup