이 문서는 팀 프로젝트의 코드 스타일, Git 사용 규칙, 브랜치 전략, 커밋 메시지, PR 규칙을 통일하기 위한 컨벤션 문서입니다.
팀원 모두가 동일한 기준으로 코드를 작성하여 다음을 목표로 합니다.
- 코드 가독성 향상
- 유지보수 비용 감소
- 협업 과정에서의 충돌 최소화
- 일관된 Git 히스토리 관리
- 원활한 코드 리뷰 문화 형성
- 코드는 다른 팀원이 이해하기 쉽게 작성합니다.
- 의미가 분명한 변수명, 함수명, 클래스명을 사용합니다.
- 불필요하게 긴 함수는 분리합니다.
- 중복 코드는 공통 함수 또는 클래스로 분리합니다.
- 주석은 “무엇을 했는지”보다 “왜 했는지”를 설명할 때 사용합니다.
- 사용하지 않는 코드, 주석 처리된 코드, 불필요한 로그는 커밋하지 않습니다.