Development Guide

Development Guide

GovOn 프로젝트 개발 규칙과 프로세스를 요약합니다. 상세 내용은 CONTRIBUTING.md를 참고하세요.

브랜치 전략 (GitHub Flow)

• main 단일 브랜치 — 모든 변경은 PR 머지로만 반영
• 브랜치 네이밍: feat/이슈번호-설명, fix/, docs/, chore/, refactor/, test/

커밋 컨벤션

Conventional Commits 기반, 한글 작성 허용

feat: 민원분석 API 도구 4개 추가
fix: api_lookup 응답 파싱 수정
docs: Wiki Getting Started 작성

타입: feat, fix, docs, style, refactor, test, chore, perf

PR 프로세스

1. feature 브랜치에서 작업
2. PR 생성 (대상: main)
3. CI 통과 + 리뷰어 승인
4. Squash merge

코드 스타일

• Formatter: black (line-length=100)
• Import sort: isort (black profile)
• Linter: flake8, mypy
• Logger: loguru.logger 사용 (print 금지)
• 모든 public 함수에 타입 힌트

테스트

pytest tests/ -v --cov=src --cov-report=term-missing

• 새 코드 80% 이상 커버리지 목표
• GPU 불필요 환경: mock 기반 테스트 가능

주요 Makefile 명령

make lint          # 코드 검사
make format        # 자동 포맷팅
make test          # 테스트 실행
make docker-build  # Docker 이미지 빌드

관련 문서

• Getting Started — 설치 가이드
• Troubleshooting — 문제 해결
• CONTRIBUTING.md — 기여 가이드 전문