주요 문서

---

코드 스타일

• 코드 스타일 가이드 - Spotless를 사용한 코드 포맷팅 규칙 및 Git Hook 설정

필수 세팅작업

---

IntelliJ IDEA JDK 설정

• File > Project Structure > Project Settings > Project
  • SDK: Amazon Corretto 21 선택
  • Language level: SDK default 선택
  • Apply 클릭

IntelliJ IDEA Gradle 설정

• File > Settings > Build, Execution, Deployment > Build Tools > Gradle
  • 
  • Build and run using: IntelliJ IDEA
  • Run tests using: IntelliJ IDEA
  • Apply 클릭

Git Hooks 설치

• 프로젝트 최초 설정 시 반드시 Git Hooks를 설치해야 합니다.
• ⚠️ 매우 중요: 이 설정은 코드 품질을 자동으로 보장하는 핵심 장치입니다!
  • Git Hooks는 커밋 전 자동으로 Spotless를 실행하여 코드 포맷팅을 검사합니다.
  • 포맷팅되지 않은 코드는 커밋이 차단되어, 일관된 코드 스타일을 강제합니다.
  • 이를 통해 팀 전체가 동일한 코드 스타일을 유지할 수 있습니다.
• 다음 명령어 중 하나를 실행하여 설치할 수 있습니다:

  # 방법 1: installGitHooks 태스크 직접 실행
  ./gradlew installGitHooks
  
  # 방법 2: build 태스크 실행 시 자동 설치
  ./gradlew build

• 설치 확인 방법:

  # pre-commit 파일 존재 확인
  ls -l .git/hooks/pre-commit
  
  # pre-commit 파일 실행 권한 확인
  .git/hooks/pre-commit