-
깃허브 커밋 메세지 컨벤션프로젝트 관련/Git 2023. 12. 11. 00:01
Angular 9의 커밋 메시지 규약
https://velog.io/@outstandingboy/Git-커밋-메시지-규약-정리-the-AngularJS-commit-conventions
요약
형태
<type>(<scope>): <short summary> <BLANK LINE> <body> <BLANK LINE> <footer><type>에 들어갈 수 있는 항목들
feat: 새로운 기능 추가fix: 버그 수정docs: 문서 관련style: 스타일 변경 (포매팅 수정, 들여쓰기 추가, …)refactor: 코드 리팩토링test: 테스트 관련 코드build: 빌드 관련 파일 수정ci: CI 설정 파일 수정perf: 성능 개선chore: 그 외 자잘한 수정
<short summary> 요약 설명
명령문, 현재 시제로 작성
첫글자를 대문자로 쓰지 마세요. 소문자로 쓰세요. --> udacity는 대문자로 시작하는 차이가 있음
마지막에 마침표(.)를 붙이지 마세요
메시지 내용 (Message Body)
명령문, 현재 시제로 작성하길 권장합니다.
변경한 이유와 변경 전과의 차이점을 설명합니다.
메시지 하단 (Message Footer)
주요 변경 내역들 (Breaking Changes)
모든 주요 변경 내역들은 다음과 함께 하단에 언급되어야 합니다.
변경점 (description of the change) 변경 사유 (justification) 마이그레이션 지시 (migration instructions) 해결된 이슈 (Referencing Issues) -> 해결된 이슈는 커밋 메시지 하단에 Closes #<이슈번호> 와 같이 기록되어야 합니다. -> Angular 9 규약에서는 "Fixes" 키워드를 사용하기도 합니다
Udacity의 Git Commit Message Style Guide
요약
태그: 제목의 형태로, : 뒤에만 space가 있음에 유의한다.feat: 새로운 기능 추가fix: 버그 수정docs: 문서 수정style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우refactor: 코드 리펙토링test: 테스트 코드, 리펙토링 테스트 코드 추가chore: 빌드 업무 수정, 패키지 매니저 수정
제목
은 마침표 및 특수기호는 사용하지 않는다.
영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기한다. (과거 시제를 사용하지 않는다.)
제목은 개조식 구문으로 작성한다. --> 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미.
본문
은 한 줄 당 72자 내로 작성한다.
본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
본문 내용은 어떻게 변경했는지 보다
무엇을 변경했는지 또는왜변경했는지를 설명한다.
꼬릿말
은 다음의 규칙을 지킨다.
꼬리말은
optional이고이슈 트래커 ID를 작성한다.꼬리말은
유형: #이슈 번호형식으로 사용한다.여러 개의 이슈 번호를 적을 때는 쉼표(,)로 구분한다.
이슈 트래커 유형은 다음 중 하나를 사용한다.
-
Fixes: 이슈 수정중 (아직 해결되지 않은 경우) -
Resolves: 이슈를 해결했을 때 사용 -
Ref: 참고할 이슈가 있을 때 사용 -
Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
ex) Fixes: #45 Related to: #34, #23
커밋 예시
Feat: 회원 가입 기능 구현 SMS, 이메일 중복확인 API 개발 Resolves: #123 Ref: #456 Related to: #48, #45
'프로젝트 관련 > Git' 카테고리의 다른 글
todoist box (0) 2023.12.30 Git Hub : 민감한 정보 담긴 pr 지우는 방법 (0) 2023.12.11 Git Hub - 원하는 commit 만 pr 보내기 (0) 2023.12.11 Git 다른 branch commit 가져오기 (0) 2023.12.04 깃 이그노어 .gitignore 파일 생성 site (0) 2023.12.02 -