ℹ️ Commit 규칙

[말머리]: (제목) #이슈번호

• 본문 1
• 본문 2
• 본문 3…

• 말머리

  • Init: 개발 환경과 관련하여 초기 세팅 등을 커밋할 시에 사용합니다.
  • Install: 패키지를 설치해 커밋했을 경우에 사용합니다.
  • Add: 기능을 위해 신규 파일을 생성했을 경우에 사용합니다.
  • Fix: **Bug**로 보고되지 않은 기존 작업 사항에서 수정된 사항이 있을 경우에 사용합니다.
    • 파일 이동이나 이름 변경도 **Fix**로 관리합니다.
  • Remove: 기존 작업 사항 중에 삭제된 파일이 있을 경우에 사용합니다.
    • 폴더 이동, 파일 이동, 이름 변경으로 인해 삭제된 경우는 **Fix**로 관리합니다.
    • 순수하게 파일을 삭제한 경우만 **Remove**를 사용합니다.
  • Bug: QA 진행 중 발견한 Bug로 인해 내용을 수정했을 시에 사용합니다.
  • Merge: 두 개의 브랜치를 병합할 시에 사용합니다.
    • Conflict: 병합 중 충돌이 발생했을 경우, Merge 키워드 뒤에 붙여줍니다.
  • Release: 배포를 진행할 시에 사용합니다.
  • Docs: README 등의 문서 작업을 진행했을 시에 사용합니다.
    • 문서 추가, 수정은 해당 태그를 사용하되 문서 삭제는 파일이 삭제된 것이므로 **Remove**를 사용합니다.

• 제목

  • 제목은 한글 기준 50글자 이내 작성합니다.
  • 작업한 내용들을 통합해서 어떤 작업을 했는지 요약해서 씁니다.
  • 깃허브에 이슈로 등록된 사항과 관련한 커밋일 경우, 제목 끝에 이슈 번호를 명시합니다.

• 본문

  • 필요에 따라 제목에 요약된 내용들을 상세하게 작성합니다.
  • 작성 시, 앞에 하이픈을 붙여 내용을 한 줄씩 정리합니다.

ℹ️ Pull Request 규칙

[말머리]: (제목) #이슈 번호

🧰 작업 사항

내용…

🔍 예상 결과

• 내용1
• 내용2…

🤔 확인 필요

• 내용1
• 내용2…

🔖 노트

• 링크…

• 말머리(tag)

  • 태그는 Pull Request의 라벨과 동일하게 갑니다.
  • Init: 개발 초기 환경을 정립 시에 사용합니다.
  • Enhancement: 하나의 Task 이슈를 작업 완료 시에 사용합니다.
  • Bug: 이슈로 등록된 버그를 수정했을 시에 사용합니다.
  • HotFix: 긴급 수정으로 인해 작업했을 시에 사용합니다.
  • Confirm: feature에서 develop으로 병합할 경우에 사용합니다.
  • Release: develop에서 main으로 병합할 경우에 사용합니다.
    • 해당 사항 병합 시, 릴리즈 노트를 꼭 작성합니다.

• 제목(title)

  • 특정 사항을 제외하고는 이슈에 등록된 제목을 따라갑니다.
  • 이슈가 없는 PR일 경우, 어떤 내용인지 한글 기준 50자 이내로 요약해서 작성합니다.
  • 이슈가 있는 PR일 경우, 제목 뒤에 꼬리말로 이슈 번호를 추가합니다.

• 라벨(label)

  • PR 관리를 위해 태그와 동일한 라벨을 지정합니다.

• 작업자(assignee)

  • 작업한 본인을 지정해줍니다.