[Git] 커밋 메시지 컨벤션

DevHwan·2022년 9월 26일
0

🏃‍♂️ 깃 커밋 메시지 컨벤션


이상적인 커밋 메시지를 작성하기 위해서는 원칙을 정하고 일관적으로 작성해야 한다. 그 중에서 가장 많이 사용하는 커밋 메시지 스타일인 유다시티의 스타일을 정리해봤다. -> 내가 쓰려고,,

📌 커밋 타입


유다시티에서는 타입을 다음 7개중 하나로 쓸 것을 권장하고 있다.

  • feat : 새로운 기능 추가

  • fix : 버그 , 오류 수정

  • docs : 문서 수정

  • style : 코드의 변화와 관련없는 포맷, 세미콜론 수정 등

  • refactor : 코드 리팩토링

  • test : 테스트 코드 , 리팩토링 테스트 코드 등 테스트 코드 관련

  • chore : 빌드 업무 수정 , 패키지 매니지 설정 관련 ( Production code와 무관)

📌 제목


  • 제목은 50자를 넘기지 않으며, 대문자로 시작하는 명령형 문장으로 작성

    feat: Summarize changes in around 50 characters or less

📌 본문 , 내용


  • 선택사항으로 반드시 작성할 필요는 없다.
  • 부연설명이나 커밋에 설명이 필요한 경우 작성한다.
  • 72자를 넘기지 않고, 제목과 구분하기 위해서 한 줄 띄고 작성한다.

📌 맺음말


  • 역시 선택사항으로 반드시 작성할 필요는 없다.
  • 기존에 연관되어있던 이슈나 참고할 이슈가 있다면 태그한다.

📌 예시


feat: Summarize changes in around 50 characters or less

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789
profile
달리기 시작한 치타

0개의 댓글