ILLDAN Backend 🚀

🔒 Rules

Branch

Jira 이슈 기반으로 브랜치를 생성합니다.

• 브랜치 형식

  • [타입]/[지라-이슈번호]/[기능-요약]
  • ex) feature/ILLDAN-123/user-profile

• main branch

  • 현재 서비스 중인 브랜치
  • release 브랜치에서 검수가 완료된 소스 코드 병합
  • PR이 병합된 경우 prod-cicd.yml 스크립트 실행

• release branch

  • 검수 중인 브랜치로 Staging 환경 역할
  • release/v* 형식의 브랜치 이름 사용
  • 검수 완료 후 main 브랜치로 병합, 이후 브랜치 제거

• develop branch

  • 개발 중인 기능 병합 브랜치
  • 배포 단위 기능 모두 병합 시 release 브랜치로 분기
  • PR 병합 또는 코드 푸시 시 test-cicd.yml 스크립트 실행

• hotfix 브랜치

  • 배포 후 긴급 수정 시 사용

Commit Message

커밋 메시지 최상단에 Jira 이슈 번호를 포함합니다.

• 커밋 형식
  • [지라-이슈번호] [[태그]] : [작업 내용 요약]
  • ex) ILLDAN-123 [feat] : 로그인 기능을 추가한다
• Body는 추가 설명 필요하면 사용

작업태그	내용
feat	새로운 기능 추가 / 일부 코드 추가 / 일부 코드 수정 (리팩토링과 구분) / 디자인 요소 수정
fix	버그 수정
refactor	코드 리팩토링
test	테스트코드 추가
pref	성능 개선 작업
style	코드 의미에 영향을 주지 않는 변경사항 (코드 포맷팅, 오타 수정, 변수명 변경, 에셋 추가)
chore	빌드 부분 혹은 패키지 매니저 수정 사항 / 파일 이름 변경 및 위치 변경 / 파일 삭제
docs	문서 추가 및 수정
rename	패키지 혹은 폴더명, 클래스명 수정 (단독으로 시행하였을 시)
remove	패키지 혹은 폴더, 클래스를 삭제하였을 때 (단독으로 시행하였을 시)

Pull Request (PR)

PR 제목에 Jira 이슈 번호를 포함하여 어떤 작업인지 명확히 합니다.

• PR 제목 형식

  • [지라-이슈번호] [[대표 태그]] : [PR의 전체 기능 요약]
  • ex) ILLDAN-123 [feat] : 사용자 프로필 조회 기능 구현

• PR 본문 (Body) 추천 내용

  • 작업 내용: 이 PR이 어떤 작업을 했는지 요약
  • 관련 이슈: Jira 이슈 티켓 링크 (ex: close #ILLDAN-123)
  • 중점 리뷰 포인트: 리뷰어가 집중해서 봐야 할 부분
  • 테스트 결과: 테스트 방법 및 결과, 스크린샷 등

Naming

• 패키지명 : 한 단어 소문자 사용 Ex) service
• 클래스명 : 파스칼 케이스 사용 Ex) JwtUtil
• 메서드명 : 카멜 케이스 사용, 동사로 시작 Ex) getUserScraps
• 변수명 : 카멜 케이스 사용 Ex) jwtToken
• 상수명 : 대문자 사용 Ex) EXPIRATION_TIME
• 컬럼명 : 스네이크 케이스 사용 Ex) user_id

---