커밋 메시지 (Commit Message)
새로 만든 커밋에 어떤 작업을 했는지 내용을 작성이 필요합니다.
한 줄에 다 표현하기 힘든 경우에는 상세 내용을 추가할 수 있습니다.
(상세 내용을 작성할 때에는 반드시 중간에 한 줄이 비어 있어야 의도한 대로 커밋 메세지가 출력됩니다.)
Conventional Commit에서 정의한 분류 중 필요한 부분을 가져와서 사용 것이 좋다.
- fix: 버그를 수정한 경우
- doc: 코드 수정 없이 문서만 추가된 경우
- style: 코드 포맷팅을 수정한 경우
- chore: 그 밖의 잡다한 일을 처리한 경우ex) 예시
- 회원가입 기능을 추가한 경우
feat: 회원가입 기능 추가
- 회원가입 API 추가
- 사용자 스키마 추가
- 비밀번호 입력 예외 처리- 로그인 시 비밀번호 비교 로직 수정
fix: 로그인 시 500 에러 발생 버그 수정
- 로그인 시 비밀번호 비교 로직 수정
- 로그인 기능 버그를 수정한 경우- README.md 파일에 사용법을 추가한 경우
docs: 프로젝트 사용 방법 추가
- README.md 파일에 설치 및 사용 방법 추가- 코드 포맷팅을 수정한 경우
docs: 프로젝트 사용 방법 추가
- README.md 파일에 설치 및 사용 방법 추가- 불필요한 console.log를 제거한 경우
chore: 사용하지 않는 console.log 제거브랜치 이름 (Branch Name)
해당 브랜치에서 어떤 작업을 진행 중이구나를 알 수 있도록 작명하도록 해야합니다.
개인 별 브랜치를 만들어서 관리하면 어떤 진행을 하고 있는지 알 수 없기 때문에 좋지 않습니다.
브랜치를 보통 Github의 이슈(Issue)와 연관 된 경우가 많기 때문에 브랜치명에 이슈 번호를 함께 표시하기도 합니다.
브랜치 이름에는 공백을 허용하지 않기 때문에 Hypen(하이픈, -)으로 연결합니다.
커밋 메세지에서 사용한 분류를 그대로 사용하겠습니다.
- feat/config-기능-구현#1 // Github 이슈 1에 정의 된 Config 기능 구현을 위한 브랜치
- docs/사용방법-문서화#4 // Github 이슈 4에 정의 된 사용 방법 문서화를 위한 브랜치
Newbie