git - 작성 규칙

doohyunlm·2021년 4월 5일
2

git

목록 보기
1/2

  1. git 작성 규칙
  2. 제목 구분자
  3. 마치며
  • git의 커밋을 찍을때 아무 코멘트 없이 커밋을 찍을 수 있지만 유지보수, 협업, 코드관리 측면에서 코멘트를 남깁니다.
  • git 작성 규칙을 따라서 작성하게 되면 보다 통일적이고 명시적으로 코멘트를 작성할 수 있습니다.



git 작성 규칙


  1. 제목과 본문을 빈 행으로 분리

  2. 제목 행을 50자로 제한

  3. 제목 행 첫 글자는 대문자

  4. 제목 행 끝에 마침표 X

  5. 제목 행에 명령문을 사용

  6. 본문을 72자 단위로 대행

  7. 어떻게 보다는 무엇과 왜를 설명



제목 구분자


  • Feat : 새로운 기능 추가

  • Fix : 버그 수정

  • Docs : 문서 수정

  • Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우

  • Refactor : 코드 리팩토링

  • Test : 테스트 코드, 리팩토링 테스트 코드 추가

  • Chore : 빌드 업무 수정, 패키지 매니저 수정

  • Add : 기능도 아니고 문서도 아니고 애매한 무언가를 추가할 때

  • Delete : 삭제

  • Update : 버전 업데이트

  • Rename : 이름 변경

  • Modify : 수정

  • Correct : 문법오류, 타입변경, 오타



마치며

틀린 부분이 있거나 추가할 사항이 있으면 말씀해주시면 감사하겠습니다.

profile
백엔드 개발자

0개의 댓글