Home

Jump to bottom

Seoyoung Cho edited this page Jan 15, 2026 · 7 revisions

Cherrish 프로젝트 문서

📚 문서 목차

이 프로젝트의 모든 컨벤션과 가이드는 주제별로 분리되어 있습니다. 필요한 문서를 클릭하여 확인하세요.

🤝 팀 협업

Ground Rule

Cherrish 팀의 협업을 위한 기본 규칙

커뮤니케이션 규칙 (2시간 내 응답, 존중하는 말투)
문서화 규칙 (최신화 관리)
코드 관리 규칙 (명확한 커밋/PR, 적절한 분리)
기술 스택 선정 규칙 (근거 있는 선정)

🏗️ 아키텍처

아키텍처 가이드

프로젝트의 전체 구조와 레이어별 책임에 대한 가이드

패키지 구조 (DDD 레이어드 아키텍처)
레이어별 책임 (Controller, Service, Repository)
도메인 설계 및 구조

인프라 아키텍처

Cherrish 프로젝트의 인프라 구조

배포 환경 및 인프라 구성
CI/CD 파이프라인
모니터링 및 로깅

🎨 설계 문서

ERD

데이터베이스 스키마 설계

사용자 관리 테이블
시술 관리 테이블
챌린지 관리 테이블
캘린더 관리 테이블

시퀀스 다이어그램

주요 API 처리 흐름

대시보드, 온보딩, 시술 일정 추가
챌린지 조회/생성, 루틴 완료 체크
캘린더 조회

요구사항 명세서

기능 요구사항 정의

온보딩, 홈, 일정 관리
챌린지 관리

🛠️ 기술 스택

Cherrish 기술 스택

프로젝트에서 사용하는 기술 스택과 선정 이유

백엔드 기술 스택 (Spring Boot, JPA 등)
인프라 및 DevOps (AWS, Docker 등)
개발 도구 (Gradle, Checkstyle 등)

📋 컨벤션

코드 스타일 가이드

코드 작성 스타일과 네이밍 규칙

네이밍 컨벤션 (클래스, 메서드, 변수)
Checkstyle 가이드 (자동 검사 규칙)
포맷팅 규칙

코딩 가이드

실제 코드 작성 시 따라야 할 구체적인 규칙

DTO 작성 규칙
Entity 작성 규칙
Configuration 작성 규칙

API 설계 가이드

REST API 설계 및 문서화 규칙

공통 응답 컨벤션
예외 처리 컨벤션
Swagger 컨벤션

Git 워크플로우

협업을 위한 Git 사용 규칙

Commit 컨벤션
Branch 컨벤션
Issue 작성 가이드

🔄 프로세스

작업 흐름

Cherrish 프로젝트의 표준 작업 흐름

이슈 관리 및 작업 시작
테스트 및 AI 코드 리뷰
PR 작성 및 병합 프로세스
팀원 PR 검토 방법

💡 기여 가이드

컨벤션 문서 개선이 필요하다면:

관련 문서의 이슈 생성
팀원들과 논의
합의 후 문서 수정
PR 생성 및 리뷰