Project

General

Profile

Feature #1270

Updated by 성용 양 14 days ago

## 목적 

 정규 학기와 별도로 개설하는 특별·사용자 정의 학기를 지원하고 기간과 운영 상태를 관리합니다. (FR-TERM-001, 002) 

 ## 쉬운 설명 

 정규·특별·사용자 정의 학기를 만들고 학기의 상태(예정·진행·마감)를 관리합니다. 

 ## 기술 스택 

 Django 모델, 상태값(예정·진행·종료), 업무 화면, pytest. 

 ## 예상 결과(산출물) 

 Term 모델, 목록·등록·수정 화면, 상태 전환 규칙, 테스트. 

 ## 개발 작업 상세 

 1. Term 모델: 이름, 종류(정규/특별/사용자 정의), 시작·종료일, 운영 상태. 
 2. 기간 겹침·종료일 검증 규칙을 만든다. 
 3. 목록·등록·수정 화면과 권한 mixin 적용. 
 4. 현재 학기를 조회하는 서비스 함수를 만든다(다른 앱이 사용). 

 ## 완료 기준 

 - 정규·특별 학기를 등록할 수 있고 기간 검증이 동작한다. 

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

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

 ## 선행·후행·위험 

 선행: 05-01 조직 구조(단과대학·학과·전공·학위과정) 모델·관리 화면(우섭, 11/13 종료) 

 05-01. 후행: 05-04 교과목·학기별 강좌(분반)·담당교원(우섭) / 09-01 등록금 부과·납부 상태·통화(KRW/CNY)(서현) 

 ## 결과 확인 방법 

 학기를 만들고 상태를 바꿀 수 있으며, 마감된 학기의 수정은 제한되고 기간 겹침이 검사되면 완료입니다. 

 ## 시작 전 준비 

 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 링크와 확인 결과를 적고 상태와 진행률을 갱신한다. 

 ## 막힐 때 확인 

 학기 기간 겹침 허용 여부는 요구사항을 확인하고 불명확하면 00-04 자료 요청에 포함하세요. 

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

 ## 용어 풀이 

 - **mixin**: 여러 화면(클래스)에 "붙이기만 하면" 같은 기능이 추가되는 작은 공통 코드 조각입니다. 한 줄 추가로 권한 검사를 적용할 때 씁니다. 
 - **FK(외래 키)**: 한 테이블의 값이 다른 테이블의 어떤 행을 가리키게 하는 연결 값입니다. 학생이 소속 학과를 가리키는 것이 예입니다. 앱 사이에는 "앱이름.모델" 문자열로 적어 앱 간 직접 import를 피합니다. 
 - **pytest**: Python 코드를 자동으로 검사해 주는 테스트 도구입니다. 테스트 파일은 tests/ 폴더에 둡니다. 
 - **서비스 함수**: 다른 앱이 직접 DB를 건드리지 않고 이 함수를 통해서만 기능을 쓰게 만든 창구입니다. 05-04, 08-01, 09-01.

Back