코드 스타일 가이드는 개인 취향을 강제하는 문서가 아니라 팀이 같은 코드를 빠르게 읽고 고칠 수 있게 하는 약속입니다. 먼저 쓰는 언어와 기존 저장소 규칙을 확인한 뒤 자동으로 검사할 수 있는 항목부터 정하세요.
규칙을 고르는 순서
들여쓰기와 공백, 이름 규칙, import 순서, 파일 구조를 정합니다. 파이썬이라면 PEP 8, JavaScript 프로젝트라면 팀이 사용하는 포맷터와 린터의 공식 문서를 출발점으로 삼을 수 있습니다. 문서에는 규칙뿐 아니라 적용 범위와 예외 승인 방식을 적어야 합니다.
리뷰에서의 사용
사람이 매번 공백을 지적하지 않도록 포맷과 린트 검사를 CI에 연결하세요. 리뷰어는 동작, 테스트, 설계 선택에 집중합니다. 이미 큰 저장소라면 전체 파일을 한 번에 고치기보다 새 코드부터 적용하고 별도 정리 작업을 계획하세요.
효과 확인
리뷰에서 반복되는 스타일 지적이 줄었는지, 새 팀원이 같은 기준으로 PR을 보낼 수 있는지 확인합니다. 코드 품질은 스타일만으로 판단하지 말고 테스트, 명확한 오류 처리와 문서도 함께 보세요. 브랜치와 리뷰 흐름은 Git 협업 학습과 연결됩니다.