Skip to content

🍻Commit Convertion

RyooChan edited this page Jul 1, 2022 · 1 revision

커밋 메시지

커밋 메시지는 title, body, footer 로 구분한다

type: Subject

body

footer

제목은 메시지의 유형과 제목으로 구성한다

유형

유형은 제목에 포함되며 다음 유형으로 구성한다

feat : 새로운 기능을 추가할 경우

fix : 버그를 포함한 다소 급한 수정이 있을 경우

docs : 문서 변경 사항이 있을 경우

style : 코드 포맷 변경, 세미콜론 누락 등 코드의 변경이 없는 경우

refactor : 새로운 기능이나 버그 수정 없이 기존 production 코드 리팩토링을 하는 경우

test : 테스트 추가, 테스트 코드 리팩토링, production 코드의 변경이 없는 경우

chore : 빌드 작업, 패키지 구성 등 production 코드의 변경이 없는 경우

rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 진행한

remove : 파일 삭제 작업만을 수행한 경우

The Subject

제목은 50자 이하로 제한하고 마침표로 끝나지 않아야 합니다. 커밋이 무엇을 했는지보다는 명령형을 사용하여 커밋이 하는 일을 설명하면 됩니다

제목의 첫 글자는 대문자로 합니다

  • 깃모지 종류

    아이콘 코드 설명
    🎨 🎨 코드의 구조/형식을 개선합니다.
    ⚡️ 성능을 개선합니다.
    🔥 🔥 코드 또는 파일을 제거합니다.
    🐛 🐛 버그를 수정합니다.
    🚑️ 🚑 중요한 핫픽스.
    새로운 기능을 추가합니다.
    📝 📝 문서를 추가하거나 업데이트합니다.
    💄 💄 UI 및 스타일 파일을 추가하거나 업데이트합니다.
    🎉 🎉 프로젝트를 시작합니다.
    테스트를 추가, 업데이트 또는 통과합니다.
    🔒️ 🔒 보안 문제를 수정합니다.
    🔐 🔐 보안을 추가하거나 업데이트합니다.
    🔖 🔖 릴리스/버전 태그.
    ✏️ ✏️ 오타를 수정합니다.
    🔨 🔨 개발 스크립트를 추가하거나 업데이트합니다.
    🔧 🔧 구성 파일을 추가하거나 업데이트합니다.
    💩 💩 개선해야 할 나쁜 코드를 작성하십시오.
    📦️ 📦 컴파일된 파일 또는 패키지를 추가하거나 업데이트합니다.
    🔊 🔊 로그를 추가하거나 업데이트합니다.
    ⏪️ 변경 사항을 되돌립니다.
    🔀 🔀 분기를 병합합니다.

The Body

내용은 선택 사항이며 커밋에 설명이 필요한 경우 작성합니다. 어떻게가 아니라 무엇을, 왜 커밋했는지 작성하면 됩니다. 내용을 작성할 때 제목과 내용 사이에는 빈 줄이 있어야 하며 내용의 길이는 72자 이내로 제한합니다

  • 한 줄당 72자 내로 작성하고, 본문 내용은 양에 구애받지 않고 최대한 상세히 작성합니다. 어떻게x 무엇을, 왜 변경했는지 위주로 설명합니다.

The Footer

바닥글은 선택 사항이며 issue tracker ID를 참조하는데 사용됩니다

ex ) issue : #51

레퍼런스 문서

Udacity Nanodegree Style Guide

Clone this wiki locally