커밋 가이드 - Tune-Manner/wisely-diary-backend GitHub Wiki

협업을 위한 Git, Github 커밋 규칙입니다.

1. 이슈(issue) 등록

개발중인 내용이나 발생한 버그와 관련된 이슈를 발행해주세요. 이슈를 발행 시에는 분류에 맞는 라벨(label), 프로젝트(project)를 설정해주세요.

2. 브랜치(branch) 생성 규칙

{LABEL}/{BRANCH}-{ISSUE_TRACKER_NO}-{ISSUE_DESCRIPTION}

이슈를 발행 후 로컬에서 작업하기 위해 main에서 새로운 브랜치를 생성합니다. 이 때, main브랜치는 항상 최신으로 갱신 후 브랜치를 생성해주세요!

• 예시
  • chore/auth-1-start-project
  • feature/auth-2-user-login

3. 커밋 메시지(commit message)

생성된 브랜치를 통해 로컬에서 작업할 때의 메시지 규칙입니다.

{KEYWORD}: {COMMIT_MESSAGE}

• 작업 내용에 맞게 키워드를 접두사를 추가하고 내용을 입력해주세요.
• 키워드
  • feat : 새로운 기능 개발
  • refactor : 동일 기능이나 코드 개선 시
  • fix : 오타, 공백, 마크다운 파일 수정, refactor 붙이기 애매할 때
  • remove : 코드 또는 파일 삭제
  • rename : 파일명 또는 폴더명 변경
  • style : 코드 스타일 변경 또는 포맷 수정
  • docs : 문서 및 주석 수정
  • test : 테스트 관련 사항 모두
  • chore : 빌드, 패키지 관련 관련 자잘한 수정
• 예시
  • feat: 로그인 개발

4. 풀 리퀘스트(pull request) 등록

이슈에 등록한 작업을 완료하면 풀 리퀘스트에 등록해주세요. 등록 시 라벨, 프로젝트, 마일스톤을 설정하고 제목은 아래와 같은 규칙으로 작성해주세요.

#{ISSUE_TRACKER_NO} {DESCRIPTION}

• 예시
  • ex. #1 기본 프로젝트 설정
  • ex. #2 회원 로그인 기능 개발

5. 풀 리퀘스트 리뷰 및 병합(Merge)

리뷰 후에는 Squash Merge 해주세요.