Feature #1250
Updated by 성용 양 14 days ago
## 목적
모델을 각자 만들기 전에 엔터티와 관계를 합의해 두면 앱 사이 충돌과 마이그레이션 꼬임을 막을 수 있습니다.
## 쉬운 설명
앱끼리 데이터를 어떻게 연결할지(어느 모델이 어느 모델을 참조하는지) 그림과 규칙으로 정리합니다. 규칙 없이 시작하면 나중에 서로 모델이 충돌합니다.
## 기술 스택
Mermaid ERD(Markdown), Django 모델 설계, UUID 기본키, 문자열 FK.
## 예상 결과(산출물)
docs/ERD.md(Mermaid)와 모델 계약표(앱·모델·핵심 필드·참조 방향).
## 개발 작업 상세
1. 엔터티를 정리한다: 조직·학기·교원·교과목·분반, 지원자·학생·학적 이력, 수강·성적, 등록금·납부, 졸업요건·판정, 증명서 발급, 파일, 감사 로그.
2. 개인정보(이름·연락처 등)와 학사 데이터를 분리하는 경계를 표시한다(김예주의 02-01·02-02 설계와 같은 회의에서 확정).
3. 기본키는 무작위 UUID, 학번은 별도 필드(가명 식별자와 구분)로 정한다.
4. 앱 간 참조는 문자열 FK와 서비스 함수로만 한다는 규칙을 적는다.
5. 세 사람이 리뷰하고 합의한 뒤 확정한다.
## 완료 기준
- ERD와 모델 계약표가 병합되었다.
- 세 사람의 승인이 댓글로 남았다.
## 충돌 방지(소유 범위)
docs/ERD.md는 우섭 소유. 이후 모델 변경은 ERD를 갱신하는 PR을 먼저 올립니다.
## 선행·후행·위험
선행: 01-01 저장소·Django 골격·앱 스텁·설정 분리(우섭, 11/06 종료)
후행: 02-02 개인정보 분리 구조 설계·구현 골격(김예주) / 05-01 조직 구조(단과대학·학과·전공·학위과정) 모델·관리 화면(우섭) / 14-01 기존 자료 인벤토리·이관 매핑표·검증 기준(서현)
위험: 합의 지연.
## 결과 확인 방법
"완료 기준"의 각 항목을 화면 또는 명령으로 직접 확인합니다.
1. ERD와 모델 계약표가 병합되었다.
2. 세 사람의 승인이 댓글로 남았다.
3. pytest가 모두 통과한다.
4. 확인 결과(화면 캡처 또는 명령 출력 요약)를 일감 메모에 남긴다. docs/ERD.md에 앱별 핵심 모델과 연결 관계가 있고, 02·05·07 담당자가 읽고 이의가 없으면 완료입니다.
## 시작 전 준비
1. 선행 일감의 결과물(문서·코드)을 먼저 읽고 약속된 이름·구조를 확인한다.
2. 저장소를 최신으로 맞춘다: git switch main 후 git pull
3. 저장소 README(01-01 결과) 순서대로 환경을 준비한다. 보통 python -m venv .venv, 가상환경 켜기, pip install -r requirements.txt, docker compose up -d db(DB 실행), python manage.py migrate 순서이다.
4. #1226의 폴더 소유 표에서 내가 고칠 수 있는 폴더를 확인한다.
## 작업 진행 순서
1. 브랜치를 만든다: git switch -c feature/MDGU-번호-짧은이름
2. "개발 작업 상세"의 번호 순서대로 한 단계씩 구현하고, 단계마다 pytest로 확인한다.
3. 모델을 바꾸면 python manage.py makemigrations, 그다음 python manage.py migrate를 실행한다.
4. 화면은 python manage.py runserver로 실행해 직접 열어 보고 "완료 기준"과 하나씩 대조한다.
5. git add, git commit, git push 후 PR을 만든다. PR 템플릿의 체크리스트를 채우고 폴더 소유자의 리뷰를 받는다.
6. 병합 후 이 일감 메모에 PR 링크와 확인 결과를 적고 상태와 진행률을 갱신한다.
## 막힐 때 확인
연결 방식이 애매하면 "앱 간에는 문자열 FK(앱이름.모델) 사용" 규칙을 기본으로 하고 예외를 문서에 적으세요.
그래도 해결되지 않으면 일감 메모에 "무엇을 했고, 어떤 오류가 났는지"를 붙여 담당 분류 소유자 또는 팀장에게 질문하세요.
## 용어 풀이
- **FK(외래 키)**: 한 테이블의 값이 다른 테이블의 어떤 행을 가리키게 하는 연결 값입니다. 학생이 소속 학과를 가리키는 것이 예입니다. 앱 사이에는 "앱이름.모델" 문자열로 적어 앱 간 직접 import를 피합니다.
- **ERD**: 데이터 테이블들과 그 연결 관계를 그린 도면입니다.
- **마이그레이션**: 모델(코드)의 변경을 DB 구조에 반영하는 변경 기록 파일과 그 적용 작업입니다. makemigrations로 만들고 migrate로 적용합니다.
- **감사 로그**: 누가 언제 무엇을 했는지 남기는 변경 불가 기록입니다. 문제가 생겼을 때 추적하는 근거가 됩니다.
- **PR(풀 리퀘스트)**: 내 브랜치의 변경을 main에 합쳐 달라고 요청하고 리뷰를 받는 절차입니다.
- **Decimal**: 돈 계산에서 소수 오차가 생기지 않도록 쓰는 숫자 형식입니다. float 대신 사용합니다.
- **서비스 함수**: 다른 앱이 직접 DB를 건드리지 않고 이 함수를 통해서만 기능을 쓰게 만든 창구입니다.
Back