27 lines
1.6 KiB
Markdown
27 lines
1.6 KiB
Markdown
---
|
|
title: 협업 가이드라인 및 코드 거버넌스
|
|
category: Software Architecture
|
|
tags: [Collaboration, PR, Code Review, Documentation, Governance]
|
|
created: 2026-04-20
|
|
---
|
|
|
|
# [[Collaboration_Governance]] (협업과 코드 품격)
|
|
|
|
## 📌 한 줄 통찰 (The Karpathy Summary)
|
|
> 코드는 혼자 쓰는 일기장이 아니라 함께 짓는 건축물이다. 동료의 시간을 아껴주는 문서화와 소통 방식이 당신의 가치를 증명한다.
|
|
|
|
## 📖 구조화된 지식 (Synthesized Content)
|
|
- **Pull Request (PR) 에티켓**:
|
|
- "이거 고쳤습니다"는 최악의 PR이다. 무엇을(What), 왜(Why), 어떻게(How) 했는지 명시하고 가능한 시각적 결과물(스크린샷, GIF)을 첨부하여 리뷰어의 인지 부하를 줄여라.
|
|
- **Code Review Protocol**:
|
|
- P1(필수 반영), P2(권장), P3(질문/의견) 식으로 중요도를 표시하라. 비판은 날카롭게 하되 표현은 따뜻하게 하여 팀의 심리적 안정성을 유지하라.
|
|
- **The Living Document**:
|
|
- 복잡한 비즈니스 로직이나 기묘한 버그 픽스는 반드시 주석이나 README에 '의도'를 남겨라. 주석은 '무엇을 하는지'가 아니라 '왜 이렇게 했는지'를 적는 곳이다.
|
|
|
|
## ⚠️ 모순 및 업데이트 (RL Update)
|
|
- 완벽한 거버넌스를 추구하느라 소통이 무거워지면 안 된다. 빠른 배포가 필요한 시점에는 '기술 부채'를 명문화하고 나중에 갚는 기민함(Agile)도 필요하다.
|
|
|
|
## 🔗 지식 연결 (Graph)
|
|
- Related: [[React_Clean_Code_Best_Practices]] , [[Deployment_Final_Gate]]
|
|
- Foundation: [[System_Debugging_Protocol]]
|