Git

git Conventional Commits

jinsuc28 2022. 5. 6. 23:33

1. commit의 제목은 commit을 설명하는 하나의 구나 절로 완성

2. 영어로 작성하며 단어 첫글자는 대문자 ex) Importance of Capitalize

3. prefix를 꼭 앞에 달아야 함

feat: 기능 개발 관련

fix: 오류 개선 혹은 버그 패치

docs: 문서화 작업

test: test 관련

conf: 환경설정 관련

build: 빌드 관련

ci: Continuous Integration 관련

활용 예

feat: Add server.py
fix: Fix Typo server.py
docs: Add README.md, LICENSE
conf: Create .env, .gitignore, dockerfile
BREAKING CHANGE: Drop Support /api/v1
refactor: Refactor user classes

commit 할 때 기억해야 할 것

1. commit은 동작 가능한 최소단위로 자주 할 것.
2. 해당 작업단위에 수행된 모든 파일 변화가 해당 commit에 포함되어야 함.
3. 모두가 이해할 수 있는 log를 작성할 것.
4. Open Source Contribution시 영어가 강제되지만, 그렇지 않을 경우 팀 내 사용 언어를 따라 쓸 것.
5. 제목은 축약하여 쓰되(50자 이내), 내용은 문장형으로 작성하여 추가설명 할 것. 제목과 내용은 한 줄 띄워 분리할 것.
6. 내용은 이 commit의 구성과 의도를 충실히 작성할 것.