- 커밋을 진행할 시 커밋 메시지를 아래 규칙에 맞춰 작성합니다.
- PR을 머지할 시, 커밋 메시지를 squash 하되, 주요 변경 점을 머릿말에 적습니다.
<type>(<scope>): <subject> -- 헤더
<body> -- 본문
이때, type은 다음과 같습니다.
FEAT: 새로운 기능 추가FIX: 오류에 대한 수정DOCS: 문서 수정에 대한 커밋BUILD: 배포를 위한 빌드 등에 대한 커밋TEST: 테스트 코드 수정에 대한 커밋STYLE: 코드 스타일에 대한 수정 커밋CHORE: 그 외 자잘한 사항들에 대한 커밋
그리고, scope는 다음과 같습니다.
frontend: 프론트앤드 관련 사항backend: 백앤드 관련 사항project: 프로젝트 전반에 관련한 사항 (문서 등)
예시
DOCS(project): Update CONTRIBUTING GUIDE
`CONTRIBUTING.md`를 업데이트 했습니다.
- 어떤 경우에도
main브랜치에 변경사항을 바로 커밋해선 안됩니다. - 개발 과정에서, 아래 규칙에 맞게 서브 브랜치를 만들어 개발을 진행합니다.
(작업내용)/(작업 영역)형식으로 브랜치를 만듭니다. (예를들어,hotfix/login cert error나,feature/signup과 같습니다.)- 작업한 내용을
dev브랜치에 우선 머지합니다. 이 단계에서, 타 개발자의 코드 리뷰를 받는 것을 권장합니다. - 주요 분기마다 이를
main브랜치에 머지합니다.
- 사용이 완전히 완료된 서브 브랜치는 삭제합니다.
- 작업 내용은 아래 명시된 태그들을 사용합니다.
feat,bug,hotfix,docs
- 기본적으로 사용하는 언어나 라이브러리가 권장하는 코드 컨벤션을 따릅니다.
- 개발 과정에서 새로운 스택이 확정되면 이 문서에 추가합니다.
hotfix와 같이 급박한 경우, 컨벤션보다 개발을 우선하되 추후에 수정합니다.