Git Commit Convention 설정하기

메시지 구조

커밋 메세지는 크게 제목, 본문, 꼬리말 세가지 파트로 나눠지고, 각 파트는 빈줄을 두어서 구분합니다.

type(옵션): [#issueNumber - ]Subject  // -> 제목
(한 줄을 띄워 분리합니다.)
body(옵션) //  -> 본문 
(한 줄을 띄워 분리합니다.)
footer(옵션) // -> 꼬리말

 

• type : 어떤 의도로 커밋했는지를 type에 명시합니다. 자세한 사항은 아래서 설명하겠습니다.
• subject : 최대 50글자가 넘지 않도록 하고 마침표는 찍지 않습니다. 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기합니다. 
• body : 긴 설명이 필요한 경우에 작성합니다. 어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성합니다. 최대 75자를 넘기지 않도록 합니다. 
• footer : issue tracker ID를 명시하고 싶은 경우에 작성합니다.
•  

타입(type)

: 태그와 제목으로 구성되고, 태그는 영문으로 쓰되 첫 문자는 대문자로 씁니다.

• feat : 새로운 기능 추가 , 화면 추가
• fix : 버그 수정
• docs : 문서 수정
• style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• refactor : 코드 리팩토링
• test : 테스트 코드, 리팩토링 테스트 코드 추가
• chore : 빌드 업무 수정, 패키지 매니저 수정
• 제목은 50자 미만, 문장의 끝에 마침표 넣지 않음. 과거 시제 사용하지 않고, 명령어로 작성하도록 함.
• 제목 외에 추가적으로 정보를 전달하고 싶을 경우 본문에 추가 정보 기입
• 예시 : [feat] comment CRUD 기능 추가

 

제목(Subject)

• 제목은 50자를 넘기지 않고, 마침표를 붙이지 않습니다.
• 제목에는 commit 타입을 함께 작성합니다.
• 과거 시제를 사용하지 않고 명령조로 작성합니다.
• 제목과 본문은 한 줄 띄워 분리합니다.
• 제목의 첫 글자는 반드시 대문자로 씁니다.
• 제목이나 본문에 이슈 번호(가 있다면) 붙여야 합니다.

이모지(Emoji)

• 🎨 : 코드의 형식 / 구조를 개선 할 때
• 📰 : 새 파일을 만들 때
• 📝 : 사소한 코드 또는 언어를 변경 할 때
• 🐎 : 성능을 향상 시킬 때
• 📚 : 문서를 쓸 때
• 🐛 : 버그 reporting 할 때, @FIXME 주석 태그 삽입
• 🚑 : 버그를 고칠 때
• 🔥 : 코드 또는 파일을 제거 할 때, @CHANGED 주석 태그와 함께
• 🚜 : 파일 구조를 변경 할 때, 🎨과 함께 사용
• 🔨 : 코드를 리팩토링 할 때
• ☔️ : 테스트를 추가 할 때
• 🔬 : 코드 범위를 추가 할 때
• 💄 : UI / style 개선 시
• ♿️ : 접근성을 향상 시킬 때
• 🎉 : initial Commit
• ✨ : 새로운 기능을 소개 할 때
• 🤝 : 파일을 병합 할 때

라이브러리(Library)

• connected-react-router@6.8.0
• history@4.10.1
• immer@9.0.7
• lodash@4.17.21
• moment@2.29.1
• react-dom@17.0.2
• react-redux@7.2.6
• react-router-dom@5.2.0
• react-scripts@4.0.3
• react@17.0.2
• redux-actions@2.6.5
• redux-logger@3.0.6
• redux-thunk@2.4.1
• redux@4.1.2
• styled-components@5.3.3
• web-vitals@1.1.2
• axios(버전은 추후 결정, 최신으로 해도 됨)
• firebase@9.5.0 (배포 할 때 사용)
• npx create-react-app react-pwa-app —template cra-template-pwa (PWA 설정 시 사용)

Git 명령어(Git Command)

• git checkout -b 브랜치 명 (생성)
• git checkout -D 브랜치 명 (삭제)
• git remote update (깃허브 브랜치 최신화)
• git checkout -t origin/브랜치명 (깃허브에 다른사람이 만든 브랜치 가져오기)
• git add . → 변경이 일어난 모든 파일 추적
• git commit -m "커밋 메시지" -m "description 적는 곳" → 커밋을 추가하는 명령어
• git push origin (브랜치명) → github저장소에 push
• git branch -a → 모든 브랜치 목록 보기
• git branch -D (브랜치명) → 로컬 브랜치 삭제
• git push origin —delete (브랜치명) → 원격 브랜치 삭제 (—delete는 -D로 치환할 수 있다.)
• git checkout -b 브랜치 명 (생성)
• git checkout -D 브랜치 명 (삭제)
• git remote update (깃허브 브랜치 최신화)
• git checkout -t origin/브랜치명 (깃허브에 다른사람이 만든 브랜치 가져오기)
• git add . → 변경이 일어난 모든 파일 추적
• git commit -m "커밋 메시지" -m "description 적는 곳" → 커밋을 추가하는 명령어
• git push origin (브랜치명) → github저장소에 push
• git branch -a → 모든 브랜치 목록 보기
• git branch -D (브랜치명) → 로컬 브랜치 삭제
• git push origin —delete (브랜치명) → 원격 브랜치 삭제 (—delete는 -D로 치환할 수 있다.)