Git 컨벤션 | Notion

Git 작업 전체적인 약속

소스코드 작성 및 Git 작업을 시작하기 전에 JIRA 이슈 생성하기
서로 공유하는 commit 그래프는 함부로 변경하지 않기
리뷰어에게 꼭 코드리뷰 받기!
자신의 pull request는 스스로 merge하기
이슈넘버는 jira 이슈넘버로 통일!

커밋룰

Commit 메세지 구조

<type>:<subject>
// 빈 행으로 구분
<body>      // 생략가능
// 빈 행으로 구분
<footer>    // 생략가능

git commit 명령어 실행시 → 본문까지 작성 가능

-m 옵션을 추가하고 제목만 간소화해서 작성 가능

ex) git commit -m "feat: Add user property"

type 커밋유형 종류

[feat] - 새로운 기능을 추가한 경우
[fix] - 버그를 고친 경우
[design] - CSS 등 사용자 UI 디자인 변경
[!HOTFIX] - 급하게 치명적인 버그를 고쳐야하는 경우
[refactor] - 코드의 리팩토링
[docs] - 문서를 수정한 경우
[rename] - 파일, 폴더명을 수정하거나 옮기는 작업만 진행한 경우
[comment] - 필요한 주석 추가 및 수정
[chore] - 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
[remove] - 파일을 삭제하는 작업만 수행하는 경우
[test] - 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
[!BREAKING CHANGE] - 커다란 API 변경의 경우

subject 제목

- 영어로 작성( ex) feat: Add user property ) 
- 첫 글자는 대문자로
- 64자를 넘기지 않는다.
- 마침표를 붙이지 않는다.
- 개조식 구문으로 작성 (ex. feat : 로그 출력 기능 추가)

body 본문