Project

General

Profile

Feature #1269

Updated by 성용 양 13 days ago

## 목적 

 학생·교과목·졸업요건이 모두 참조하는 학사 조직 기준 데이터를 만듭니다. (FR-ORG-001) 

 ## 쉬운 설명 

 단과대학·학과·전공·학위과정의 조직 구조를 저장하고 관리하는 화면입니다. 학생·교과목이 모두 이 구조를 참조합니다. 

 ## 기술 스택 

 Django 모델(계층 관계), Django Admin + 업무 화면(ModelForm·Bootstrap 5), pytest. 

 ## 예상 결과(산출물) 

 academics 앱의 College·Department·Major·DegreeProgram 모델, 목록·등록·수정 화면, 마이그레이션, 테스트. 

 ## 개발 작업 상세 

 1. 01-02 ERD에 맞춰 모델을 만든다(단과대학→학과→전공, 학위과정). 
 2. 정식 명칭은 00-04 수령 전까지 임시 데이터로 두고, 명칭을 바꿀 수 있게 한다. 
 3. 목록·등록·수정 화면과 02-04 권한 mixin을 적용한다(권한은 mixin 한 줄). 
 4. 합성 데이터로 시드 명령(`seed_academic_sample`)을 만든다. 운영 정보는 넣지 않는다. 
 5. 모델·화면 테스트를 만든다. 

 ※ 권한(RBAC) mixin은 02-04가 끝나기 전에는 로그인 확인만 적용하고, 02-04 완료 후 한 줄을 추가하는 후속 PR로 마무리한다. 02-06 점검에서 누락 여부를 확인한다. 

 ## 완료 기준 

 - 계층 구조를 등록·수정할 수 있다. 
 - 시드 명령으로 합성 데이터가 들어간다. 

 ## 충돌 방지(소유 범위) 

 academics/ 앱은 우섭 소유. 다른 사람의 앱은 문자열 FK로만 참조합니다. 

 ## 선행·후행·위험 

 선행: 01-01 저장소·Django 골격·앱 스텁·설정 분리(우섭, 11/06 종료) / 01-02 ERD·모델 계약 초안(앱 간 FK 규칙)(우섭, 11/11 종료) / 01-04 공통 모델·기본 템플릿·레이아웃(우섭, 11/11 종료) 

 후행: 05-02 학기 모델(정규·특별·사용자 정의)·운영 상태 관리(우섭) / 05-03 교원 구분·소속 없는 강사 등록(우섭) / 05-04 교과목·학기별 강좌(분반)·담당교원(우섭) / 06-01 지원자 모델·지원 상태·입학 판정(김예주) / 07-01 학생 기본 모델·개인정보 참조·조회 화면(우섭) / 10-01 졸업요건 설정(학위과정별 필요 학점 등)(성용) 

 위험: 정식 조직 명칭 미확정. 

 ## 결과 확인 방법 

 "완료 기준"의 각 항목을 화면 또는 명령으로 직접 확인합니다. 

 1. 계층 구조를 등록·수정할 수 있다. 
 2. 시드 명령으로 합성 데이터가 들어간다. 
 3. pytest가 모두 통과한다. 
 4. 확인 결과(화면 캡처 또는 명령 출력 요약)를 일감 메모에 남긴다. 


 ## 갱신 사항 (2026-11-04) 

 - ERD 검수 반영: 증명서에 출력되는 조직·학위과정 명칭은 name_ko/name_en/name_zh로 분리한다(번역 명칭은 대학 확인). 

 ## 시작 전 준비 

 1. 선행 일감의 결과물(문서·코드)을 먼저 읽고 약속된 이름·구조를 확인한다. 
 2. 저장소를 최신으로 맞춘다: git switch main 후 git pull --ff-only origin main 
 3. 저장소 README 8번과 팀 로컬 세팅 안내 순서대로 환경을 준비한다. 보통 py -3.12 -m venv .venv, 가상환경 켜기, python -m pip install -r requirements-dev.txt, Windows에 설치한 PostgreSQL 18에서 개인 로컬 DB(university_dev) 생성, .env.local 설정(DB_NAME, DB_USER, DB_PASSWORD, DB_HOST, DB_PORT), python manage.py check, python manage.py migrate 순서이다. 최초 실행에 makemigrations는 필요 없고, .env.local과 비밀번호는 공유·커밋하지 않는다. 
 4. #1226의 폴더 소유 표에서 내가 고칠 수 있는 폴더를 확인한다. 

 ## 작업 진행 순서 

 1. 브랜치를 만든다: git switch -c feature/1269-<짧은영문설명> 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 링크와 확인 결과를 적고 상태와 진행률을 갱신한다. 

 ## 막힐 때 확인 

 조직 코드 체계는 대학 자료(00-04)를 따릅니다. 자료가 없으면 임시 코드로 만들고 표시하세요. 

 그래도 해결되지 않으면 일감 메모에 "무엇을 했고, 어떤 오류가 났는지"를 붙여 담당 분류 소유자 또는 팀장에게 질문하세요. 

 ## 용어 풀이 

 - **RBAC(역할 기반 접근 제어)**: 사람마다 허용 범위를 따로 정하지 않고 "관리자·교직원" 같은 역할에 권한을 붙여, 역할을 가진 사람만 해당 화면·작업을 쓰게 하는 방식입니다. 
 - **mixin**: 여러 화면(클래스)에 "붙이기만 하면" 같은 기능이 추가되는 작은 공통 코드 조각입니다. 한 줄 추가로 권한 검사를 적용할 때 씁니다. 
 - **FK(외래 키)**: 한 테이블의 값이 다른 테이블의 어떤 행을 가리키게 하는 연결 값입니다. 학생이 소속 학과를 가리키는 것이 예입니다. 앱 사이에는 "앱이름.모델" 문자열로 적어 앱 간 직접 import를 피합니다. 
 - **ERD**: 데이터 테이블들과 그 연결 관계를 그린 도면입니다. 
 - **마이그레이션**: 모델(코드)의 변경을 DB 구조에 반영하는 변경 기록 파일과 그 적용 작업입니다. makemigrations로 만들고 migrate로 적용합니다. 
 - **pytest**: Python 코드를 자동으로 검사해 주는 테스트 도구입니다. 테스트 파일은 tests/ 폴더에 둡니다. 
 - **PR(풀 리퀘스트)**: 내 브랜치의 변경을 main에 합쳐 달라고 요청하고 리뷰를 받는 절차입니다. 
 - **합성 데이터**: 실제 개인정보가 아닌, 시험용으로 만든 가짜 데이터입니다.

Back