코드·Git·리뷰 컨벤션
1. 주석
- 직관적 네이밍 + 적극적 주석으로 코드를 문서화
- 구현/리팩토링 예정은
TODO
2. Git 브랜치 (<prefix>/<작업 내용>)
| prefix |
용도 |
예시 |
feat/ |
새 기능 |
feat/user-login |
fix/ |
버그 수정 |
fix/login-error |
refactor/ |
구조 개선 (기능 변경 X) |
refactor/service-cleanup |
setting/ |
빌드/배포/인프라/설정 |
setting/github-actions |
hotfix |
운영 긴급 |
|
브랜치 전략은 GitHub Flow (main에서 분기 → PR → 리뷰 → merge). 소규모·신속 배포·리뷰 중심 문화에 맞춰 Git Flow 대신 채택.
3. 커밋 메시지
<type>: <subject>
<BLANK LINE>
<body> (선택, 설명 필요 시)
| type |
when |
| feat |
기능 추가 |
| update |
기능 수정 |
| fix |
버그 수정 |
| refactor |
리팩토링 |
| docs |
문서 |
| style |
오타·공백·스타일 (기능 무관) |
| test |
테스트 코드 |
| setting |
개발 환경 세팅 |
| chore |
유지보수 |
4. 코드 리뷰 — Pn 룰
- P1 (Request changes): 적극 고려. 수용 또는 합당한 의견으로 토론
- P2 (Comment): 웬만하면 반영. 못 하면 사유 설명 또는 후속 티켓 명시
- P3 (Approve): 반영해도/넘어가도 OK
5. PR 머지 룰
- 지정 리뷰어 1명 리뷰하면 머지 가능
- 머지 버튼은 리뷰이(작성자) 가 누름
6. 엔티티 타입 컨벤션 (FE)
- 변환 없음:
domain.ts 작성 안 함, types/index.ts에서 dto 타입 export
- 변환 있음:
domain.ts에 순수 스키마만(dto import 금지), 변환은 repository
XxxDTO 타입은 외부 export 안 함 (repository 내부 전용)- 네이밍:
FrontendXxx prefix 제거, 도메인 이름만
7. 관련