Project

General

Profile

Feature #1251

Updated by 성용 양 13 days ago

## 목적 

 충돌을 규칙으로 막습니다. 누가 어떤 폴더를 고치는지, 공통 파일은 어떻게 바꾸는지 정해 저장소에 적습니다. 

 ## 쉬운 설명 

 누가 어느 폴더를 바꿀 수 있는지, 브랜치 이름과 PR(변경 제출) 규칙을 문서로 정합니다. 충돌을 막는 가장 중요한 약속입니다. 

 ## 기술 스택 

 GitHub CODEOWNERS, PR 템플릿, 브랜치 보호 규칙. 

 ## 예상 결과(산출물) 

 CODEOWNERS, .github/PULL_REQUEST_TEMPLATE.md, CONTRIBUTING.md. 

 ## 개발 작업 상세 

 1. 상위 일감의 소유권 표를 CODEOWNERS로 옮긴다. 
 2. PR 템플릿(목적, 변경 앱, 테스트, 연결 일감)을 만든다. 
 3. 브랜치 이름 `feature/<일감번호>-<설명>`과 리뷰 규칙(소유자 1명 이상)을 적는다. 
 4. 공통 파일(config, core)을 바꿔야 할 때의 요청 절차를 적는다. 

 ## 완료 기준 

 - CODEOWNERS가 병합되었다. 
 - 세 사람이 규칙을 읽었다고 댓글로 확인했다. 

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

 CODEOWNERS와 .github/ 하위 템플릿은 성용(인프라) 소유 폴더이지만 이 일감에서는 우섭이 최초 작성하고 이후 성용이 관리합니다. 

 ## 선행·후행·위험 

 선행: 01-01 저장소·Django 골격·앱 스텁·설정 분리(우섭, 11/06 종료) 

 후행: 없음 

 ## 결과 확인 방법 

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

 1. CODEOWNERS가 병합되었다. 
 2. 세 사람이 규칙을 읽었다고 댓글로 확인했다. 
 3. 코드 변경이 있으면 pytest가 모두 통과한다. 
 4. 확인 결과(화면 캡처 또는 명령 출력 요약)를 일감 메모에 남긴다. 


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

 - 산출물에 docs/DEVELOPMENT_STANDARDS.md(공통 개발 기준)와 CONTRIBUTING.md 링크를 포함한다. 
 - 선행 작업: 팀원 4명의 GitHub 아이디 수집(CODEOWNERS 작성용). 
 - main 브랜치 보호(직접 push 금지, CI 통과, CODEOWNERS 승인) 적용 시점은 CI(04-02) 이후 성용과 정한다. 

 ## 시작 전 준비 

 1. 선행 일감의 결과물(문서·코드)을 먼저 읽고 약속된 이름·구조를 확인한다. 
 2. 저장소를 최신으로 맞춘다: git switch main 후 git pull --ff-only origin main 
 3. 저장소 README 8번과 팀 로컬 세팅 안내 README(01-01 결과) 순서대로 환경을 준비한다. 보통 py -3.12 python -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), requirements.txt, docker compose up -d db(DB 실행), python manage.py check, python manage.py migrate 순서이다. 최초 실행에 makemigrations는 필요 없고, .env.local과 비밀번호는 공유·커밋하지 않는다. 
 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 링크와 확인 결과를 적고 상태와 진행률을 갱신한다. 

 ## 막힐 때 확인 

 CODEOWNERS에는 이름이 아니라 GitHub 아이디를 적습니다. 소유자가 바뀌면 같은 PR에서 #1226 표도 고치세요. 

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

 ## 용어 풀이 

 - **CODEOWNERS**: 폴더별 담당자를 정해 두면 그 폴더를 고치는 PR에 담당자가 자동 리뷰어로 지정되는 GitHub 기능입니다. 
 - **PR(풀 리퀘스트)**: 내 브랜치의 변경을 main에 합쳐 달라고 요청하고 리뷰를 받는 절차입니다. 
 - **Django 템플릿**: HTML에 데이터가 들어갈 자리를 표시해 둔 화면 틀입니다. 기본(base) 템플릿을 상속해 공통 메뉴를 재사용합니다.

Back