깃허브 컨벤션

[hyunsb]

📌 커밋

Feat: title (#issue)

body (...)

• Feat : 새로운 기능 추가
• Fix : 버그 수정
• Docs : 문서 수정
• Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• Refactor : 코드 리펙토링
• Test : 테스트 코드, 리펙토링 테스트 코드 추가
• Modify : 수정이긴한데, 애매한 수정 (버그는 아니고..)
• Typo : 오타 수정
• Chore : 빌드 업무 수정, 패키지 매니저 수정

본문은 다음의 규칙을 지킨다.

• 본문은 한 줄 당 72자 내로 작성한다.
• 본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
• 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.

📌 머지

• 스쿼시머지 사용
  • 스쿼시머지 메시지 컨벤션 (얘는 큰 머지 커밋이 작은 커밋들을 감싸고 있어서 정하는게…)
    • commit message → PR 제목 (#pr number)
      • Ex) 스프링 시큐리티 기능 구현 완료 (#127)
  • PR 제목 / 내용
    • Main Issue 제목 복사 붙여넣기 + “ 완료” ? 정도
    • 오류 수정에서는 어떻게 해결했고, 어떤 자료들을 참고 했는지 정도?

📌 이슈

• 제목 알아서 짓기
• develop (기능개발)
• document (개발관련 문서 ex. 이슈 컨벤션을 이슈로 달아놔도 될 듯?)
• enhancement (개선)
• bug (버그 발생!)
• hotfix
• refactor (리팩토링)

📌 브랜치명

Prefix/#IssueNumber-작업도메인

• feature/QueryDsl 설정 추가 #12-login-service
• refactor/QR Code 발급 및 인증 기능 구현 #22-login-service
• fix/기획에 따른 엔티티 수정 완료 #14-security-config
• hotfix/개발, 운영, 테스트 환경 분리 완료 #18-jwt-authentication
• release
• develop
• main