Udacity Git Commit Message Style Guide는 무엇인가

고재경·2021년 9월 30일
1
post-custom-banner

안녕하세요😊 오늘은 UdacityGit Commit Message Style Guide에 대해 알아보도록 하겠습니다.
이렇게 메세지를 작성하면 효율적으로 관리 할 수 있다는 것이지 꼭 이렇게 사용하라는 것은 아닙니다.

Udacity란?

메세지 스타일 가이드 설명에 앞서 우선 Udacity가 무엇인지 알아보겠습니다.

Udacity는 미국의 영리 교육 기관으로 온라인 강의를 제공하는 기관입니다. 같은 느낌으로 Udemy, Coursera 등의 기관이 있습니다. 한국의 부스트코스, 패스트캠퍼스라고 생각하시면 되겠네요.

Udacity Git Commit Message Style Guide?🧐

그렇다면 유다시티의 깃 커밋 메세지 스타일이란 무엇일까요?
우선 해당 커밋 메세지의 구조부터 살펴보겠습니다.

Message Structure

유다시티에서 소개하는 커밋 메세지 스타일은 다음과 같은 구조를 가집니다.

Message Type : Subject // 작업 내용을 간단하게 요약해서 기술합니다.

Body // 왜, 무엇을 변경하였는지 기술합니다. 작성하지 않아도 괜찮습니다.

Footer // issue tracker를 사용하는 경우 참조한 issue tracker ID를 기술합니다. 작성하지 않아도 됩니다.

이제 각각의 파트에 어떠한 내용이 들어가는지 알아봅시다.

Message Type

메세지 타입에는 7가지가 있는데 어떤것이 있고 어떤 상황에서 어떤 타입을 작성하는지 알아보도록 할게요😊

  • feat : 새로운 기능을 추가하였을 때
  • fix : 버그를 수정하였을 때
  • docs : README 등 문서 내용을 변경하였을 때
  • style : 들여쓰기, 세미콜론 등을 변경하였을 때
  • refactor : 코드 리팩토링을 했을 때(기능의 변경은 없어야 한다.)
  • test : test코드의 작성 및 수정이 이루어졌을 때
  • chore : 외부 라이브러리 임포트 등의 작업을 완료했을 때

References

https://udacity.github.io/git-styleguide/

post-custom-banner

0개의 댓글