아키텍처 변경 요청
아키텍처 변경 요청을 통해 구조화된 검토 워크플로우를 거쳐 C4 모델의 수정을 제안할 수 있습니다. 아키텍처를 직접 편집하는 대신, 팀원이 검토, 논의, 병합할 수 있는 요청을 생성합니다.
작동 방식
변경 요청은 아키텍처 모델에 대한 하나 이상의 제안된 변경을 그룹화합니다. 코드 저장소의 풀 리퀘스트와 유사한 라이프사이클을 따릅니다:
- 제목과 설명으로 요청 생성
- 변경 추가 — C4 요소(시스템, 컨테이너, 컴포넌트, 코드 요소, 관계, 오버레이)의 생성, 수정, 삭제
- 제안이 준비되면 검토 요청
- 검토 — 팀원이 승인, 변경 요청 또는 코멘트
- 병합하여 모든 변경 사항을 라이브 아키텍처에 적용
요청 라이프사이클
각 요청은 다음 상태를 거칩니다:
| 상태 | 설명 |
|---|---|
| 초안 | 작업 진행 중. 작성자만 변경 사항을 보고 편집할 수 있음. |
| 열림 | 검토를 위해 제출됨. 팀원이 검토하고 코멘트 가능. |
| 승인됨 | 승인을 받았으며 병합 준비됨. |
| 병합됨 | 변경 사항이 아키텍처 모델에 적용됨. |
| 닫힘 | 거절되거나 중단됨. 작성자가 다시 열 수 있음. |
요청 만들기
요청 탭에서
- 프로젝트로 이동
- 요청 탭 열기
- 새 요청 클릭
- 제목(최대 200자)과 선택적 설명 입력
- 요청은 초안 상태로 시작
변경 추가
초안 또는 열린 요청 내에서 다음을 선택하여 변경을 추가합니다:
- 작업: 생성, 수정 또는 삭제
- 요소 유형: 시스템, 컨테이너, 컴포넌트, 코드, 관계 또는 오버레이
- 요소 데이터: 새 요소 또는 수정된 요소의 속성
변경 사항은 작업 유형(생성, 수정, 삭제)별로 그룹화되어 쉽게 검토할 수 있습니다.
요청 편집
작성자는 병합되지 않은 요청의 제목과 설명을 언제든지 편집할 수 있습니다. 제목 옆의 연필 아이콘을 클릭하여 편집 모드로 진입합니다.
요청 검토
리뷰 제출
편집 권한이 있는 팀원이 열린 요청을 검토할 수 있습니다:
- 승인 — 제안이 적절함
- 변경 요청 — 병합 전 수정이 필요
- 코멘트 — 공식적인 결정 없이 피드백 제공
활동 피드
활동 탭에는 모든 리뷰와 코멘트가 시간순으로 표시됩니다. 하단의 코멘트 작성기를 사용하여 공식 리뷰 없이 간단한 코멘트를 남길 수 있습니다.
요청 병합
요청이 검토되고 승인되면:
- 요청 상세 페이지 열기
- 병합 클릭
- 모든 변경 사항이 C4 모델에 원자적으로 적용됨
편집 권한이 있는 팀원만 요청을 병합할 수 있습니다.
변경 사항 미리보기
미리보기 탭에서는 변경 사항이 적용된 후 아키텍처가 어떻게 보일지 시각적으로 표현하여, 리뷰어가 병합 전 영향을 이해할 수 있습니다.
모범 사례
명확한 제목 작성
의도를 설명하는 설명적인 제목을 사용하세요:
- "결제 서비스 및 Stripe 통합 추가"
- "모놀리식 API를 사용자 및 주문 서비스로 분리"
- "폐기된 알림 컴포넌트 제거"
요청을 집중적으로
- 요청당 하나의 논리적 변경
- 관련 없는 수정을 섞지 않기
- 작은 요청이 검토하기 쉬움
설명 활용
제안된 변경의 이유를 설명하세요:
- 이 아키텍처 변경이 왜 필요한지
- 어떤 대안이 고려되었는지
- 관련 ADR 또는 문서에 대한 링크
병합 전 검토
- 최소 한 번의 승인을 권장
- 코멘트를 사용하여 트레이드오프 논의
- 미리보기 탭에서 결과 확인