CAUSW Backend (중앙대학교 소프트웨어학부 동문네트워크 백엔드, Spring Boot 4.0 / Java 25) 의 아키텍처, 코드 컨벤션, 도메인별 책임을 정리한 문서 모음입니다.
신규 기여자와 AI 코딩 어시스턴트가 프로젝트 구조와 관례를 빠르게 파악하기 위한 레퍼런스로 사용합니다.
| 카테고리 | 설명 |
|---|---|
| architecture.md | 모듈 구성, 패키지 레이어, 의존성 흐름 등 전반적인 아키텍처 |
| conventions/ | API, 서비스, 영속화, 예외, 코드 스타일 등 코드 컨벤션 |
| cross-cutting/ | 보안, 관측성, 외부 인프라, 배치 등 횡단 관심사 |
- 프로젝트 개요: 루트의 README.md
- 기여 가이드: 루트의 CONTRIBUTING.md
- 환경 변수 /
.env운영: docs/env_guide.md - DB 마이그레이션 (Flyway): docs/flyway_guide.md
- 모든 가이드는 한국어로 작성합니다.
- 파일경로:라인번호 형식의 인용은 사용하지 않습니다 — 라인이 바뀌면 문서가 빠르게 노후화됩니다. 대신 "어떤 디렉터리에 어떤 명명 패턴의 클래스로 존재하는지" 를 설명하세요 (예:
core/security/의*FilterChain*Bean,service/implementation/의*Reader/*Writer컴포넌트). - 클래스명 / 패키지명을 인용할 때는
.java확장자 없이 표기합니다 (PostController,core/security/WebSecurityConfig). - 코드 컨벤션이 변경되면 해당 문서를 함께 갱신하는 것을 원칙으로 합니다.