0. Project Information

프로젝트 주제: nearPick

NearPick은 사용자가 자신의 위치 기반으로 “내 동네에서 지금 인기 있는 상품”을 실시간으로 확인하고, 예약 또는 선착순으로 구매할 수 있는 커머스 플랫폼입니다.

• 지역별 찜(좋아요) 이벤트를 Kafka로 수집하고, Redis에 캐싱하여 Top N 인기 상품을 빠르게 노출

• 예약 마감 시점 또는 선착순 재고 소진 시 Kafka Consumer가 자동으로 주문 확정·실패 처리

컨벤션

커밋 컨벤션

• 하나의 PR은 1,000 라인을 넘을 수 없음

• Pull Request·Commit 단위는 최소 기능 단위로 세분화

• 테스트 코드(Mock JSON 등)는 라인 수 제한에서 제외

• 리뷰 받을 내용에 제폼 PR 템플릿에 맞춰 PR 타입, 반영 브랜치, 관련 이슈, 변경 사항, 테스트 결과가 들어가야함.

• Conventional Commits 사용.

  • feat: 새로운 기능
  • fix: 버그 수정
  • docs: 문서
  • style: 코드 포맷팅 (기능 변경 없음)
  • refactor: 리팩토링 (기능 변경 없음)
  • test: 테스트 코드
  • chore: 빌드∙CI 설정 등
  • perf: 성능 개선
  • ci: CI/CD 설정

코딩 컨벤션

• 빌드 Phase에 ktlint를 실행시켜 자동으로 코딩 스타일을 맞춰지는 프로세스

• GitHub의 Pull Request Opened, Commit Changed를 Trigger로 테스트 코드를 실행하며, 그 결과를 PR 의 status 에 반영하는 과정을 자동화

네이밍

클래스: UpperCamelCase

메서드·변수: lowerCamelCase

상수: UPPER_SNAKE_CASE

DB 테이블·컬럼: snake_case

Git-Flow 브랜치 전략

main

• 항상 배포 가능한 상태 유지

• 태그(v1.0.0 등) 관리

develop

• 차기 배포 대상 통합

• 모든 feature/ 브랜치가 이곳으로 머지

feature/*

• 기능 단위 브랜치 (feature/login, feature/reservation)

• 완료 시 develop에 PR

release/*

• 배포 준비용 브랜치 (release/1.0.0)

• 완료 후 main·develop에 머지 & 태그 생성

hotfix/*

• 운영 긴급 수정 브랜치 (hotfix/1.0.1)

• 수정 후 main·develop 머지 & 태그 업데이트

Pull Request: 반드시 이슈/티켓 번호 참고, 동료 리뷰 후 머지

Reference: 뱅크샐러드의 코드 리뷰 문화