Git - 커밋 컨벤션

Hyeon Woohyeon·2022년 6월 23일

Git

목록 보기
11/13
post-thumbnail

feat. 얄코 - 얄코님의 강의와 참고자료 활용

📌 커밋 컨벤션

  • 커밋 메시지 작성 방식

    커밋을 할때 권장 사항

    1. 하나의 커밋에는 한 단위의 작업을 넣는다.
      • 한 작업을 여러 버전에 걸쳐 커밋 ❌
      • 여러 작업을 한 버전에 커밋 ❌
    2. 커밋 메시지는 어떤 작업이 이뤄졌는지 알 수 있도록 하기
  • 커밋 메시지 컨벤션
type: subject

body (optional)
...
...
...

footer (optional)

✏️ type

타입설명
feat새로운 기능 추가
fix버그 수정
docs문서 수정
style공백, 세미콜론 등 스타일 수정
refactor코드 리팩토링
perf성능 개선
test테스트 추가
chore빌드 과정 또는 보조기능(문서 생성 기능 등) 수정

✏️ subject

커밋의 작업 내용 간략히 설명


✏️ body

길게 설명할 필요가 있을 시 작성


  • Breaking Point 가 있을 때
  • 특정 이슈에 대한 해결 작업일 때

예시

feat: 압축파일 미리보기 기능 추가

사용자의 편의를 위해 압축을 풀기 전에
다음과 같이 압축파일 미리보기를 할 수 있도록 함
 - 마우스 오른쪽 클릭
 - 윈도우 탐색기 또는 맥 파인더의 미리보기 창

Closes #125

0개의 댓글