Git Convention(깃 컨벤션)
- git 컨벤션이란 깃에 커밋할때
git commit message를 작성하는 규칙이다.
- 작성할때 크게 3구조로 나뉜다.
1. 타입(type) 제목(title or Subject)
2. 본문(body)
3. 꼬리말(footer)로 구분된다.
타입(type)
커밋의 타입종류다. 자주쓸거같은건 빨간색으로 표시했다.
| Type | 설명 |
|---|
| Feat | 새로운 기능 추가 |
| Fix | 버그 수정 |
| Docs | 문서 수정 |
| Style | 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우 |
| Refactor | 코드 리펙토링 |
| Test | 테스트(테스트 코드 추가, 수정, 삭제, 비즈니스 로직에 변경이 없는 경우) |
| Chore | 위에 걸리지 않는 기타 변경사항 (빌드 스크립트 수정, assets image, 패키지 매니저 등) |
| Design | CSS 등 사용자 UI 디자인 변경 |
| Comment | 필요한 주석 추가 및 변경 |
| Init | 프로젝트 초기 생성 |
| Rename | 파일 혹은 폴더명 수정하거나 옮기는 경우 |
| Remove | 파일을 삭제하는 작업만 수행하는 경우 |
제목(title or Subject)
- 50글자 이내로 작성한다.
- 마침표 및 특수기호는 사용하지 않는다.
- 간결하게 작성한다.
본문(body)
- 제목에 내용이 다 포함된다면 생략해도 괜찮다.
- 한줄당 72자를 넘기지 않도록 한다.
- 가능한 자세히 작성한다.
- 어떻게 변경하였는지 보다 무엇을, 왜 변경하였는지 설명한다.
- 이슈 트래킹을 위해 사용된다.
- 이슈가 없다면 생략해도 괜찮다.
- 이슈 트래커
ID를 작성
꼬리말 유형: #이슈 번호의 형식으로 작성
| 꼬리말 유형 | 설명 |
|---|
| Fixes | 이슈 수정중(아직 해결되지 않은 경우) |
| Resolves | 이슈를 해결한 경우 |
| Ref | 참조할 이슈가 있을 때 사용 |
| Related to | 해당 커밋에 관련된 이슈 번호(아직 해결되지 않은 경우) |
예시1
Feat: 계산기 연산 부분 구현
사칙연산을 수행하는 기능 추가
Fixes: #123
예시2
Feat: 계산기 숫자 입력 버그 수정
피연산자 입력시 숫자만 입력되도록 수정
Resolves: #123
