개발 가이드

브랜치 네이밍

브랜치는 작업 목적에 따라 접두어(prefix)를 사용하며, 브랜치명은 소문자와 하이픈(-)으로 구성합니다.

유형	접두어	예시	설명
기능추가	feature/	feature/[name]	새로운 기능, UI, API 등
버그 수정	bugfix/	bugfix/[name]	버그 수정
핫픽스	hotfix/	hotfix/[name]	긴급 수정 (배포 중단 방지 등)
리팩토링	refactor/	refactor/[name]	구조 변경, 동작 변화 없음
문서 수정	docs/	docs/[name]	README, 문서 파일 수정
테스트	test/	test/[name]	테스트 코드 추가 및 수정
설정 변경	chore/	chore/[name]	빌드/배포 설정, 패키지 업데이트

커밋 형식

<type>([optional scope]): <short summary>

[optional body]

[optional footer(s)]

주요 타입

타입	설명
feat	새로운 기능
fix	버그 수정
docs	문서 관련 변경
style	코드 스타일 수정 (기능 변경 없음)
refactor	코드 리팩토링 (기능 변경 없음)
test	테스트 코드 추가/수정
chore	빌드, 설정, 패키지 등 기타 변경

PR 템플릿

"제목은 명확하고 간결하게 작성해주세요"
📌 개요 "어떤 변경 사항인지 요약 설명"
✅ 작업 내용
<!-- 주요 변경 사항을 bullet point로 정리해주세요 -->
- [ ] 기능 A 구현
- [ ] C 관련 테스트 추가
- [ ] ...

🔍 상세 설명 (선택)
"왜 이렇게 구현했는지, 고려사항이나 대안이 있다면 함께 작성"

🎯 관련 이슈
<!-- 이슈 번호를 닫을 경우 -->
Closes #이슈번호

📋 체크리스트
- [] 기존 기능에 영향이 없는지 확인했습니다.
- [] 테스트 코드를 추가하거나 기존 테스트가 통과하는지 확인했습니다.
- [] 관련 문서(README 등)를 업데이트했습니다.

앱 실행 방법

1. 가상환경 생성 및 활성화
   • macOS/Linux

     python3 -m venv venv
     source venv/bin/activate

   • Windows (PowerShell)

     python -m venv venv
     .\venv\Scripts\Activate.ps1

   • Windows (명령 프롬프트)

     python -m venv venv
     venv\Scripts\activate.bat

2. 필수 패키지 설치

   pip install --upgrade pip
   pip install -r requirements.txt

3. 필요 시 환경 변수 설정
   • REELS_STORAGE_DIR: 릴스 원본·분석 파일을 저장할 디렉터리 (기본: src/reels)
   • WHISPER_MODEL_NAME: Whisper 모델 이름 (기본: base)
   • macOS/Linux

     export REELS_STORAGE_DIR=/absolute/path/to/reels
     export WHISPER_MODEL_NAME=medium

   • Windows (PowerShell, 세션 한정)

     $env:REELS_STORAGE_DIR="C:\absolute\path\to\reels"
     $env:WHISPER_MODEL_NAME="medium"

   • Windows (명령 프롬프트, 세션 한정)

     set REELS_STORAGE_DIR=C:\absolute\path\to\reels
     set WHISPER_MODEL_NAME=medium

4. 앱 실행
   • macOS/Linux

     python src/app.py

   • Windows (PowerShell)

     python src/app.py

   • Windows (명령 프롬프트)

     python src\app.py

5. 테스트 실행 (선택)

   pytest