🕊️ 조직에서 코드 퀄리티 문화를 구축하는 방법

코드 품질 문화는 엔지니어링 팀의 내부적인 측면이지만 사용자에게도 직접적인 영향을 미칩니다. 고품질 코드를 사용하면 새로운 기능을 더 빨리 구현하여 사용자 경험을 향상할 수 있습니다. 1️⃣ 코드 스타일 및 표준 합의 코드 스타일 가이드 - 네이밍, 공백 및 들여쓰기와 같은 규칙을 수립하여 일관성을 유지합니다. 코드 주석 - 주석이 유용한지 확인하기 위한 규칙을 정합니다. 예를 들자면, 팀이 TODO를 푸쉬하도록 허용하지 마세요. 2️⃣ 이슈 추적기 IDE에서 직접 코드에 연결된 문제를 생성하고 관리할 수 있는 Stepsize 같은 툴을 사용하세요. 3️⃣ 퀄리티 이슈의 우선순위 결정 및 해결 코드 퀄리티 이슈의 우선순위를 정하고 수정하여 영향이 확산되기 전에 해결해야 합니다. 다음의 방법을 쓸 수 있습니다. - 엔지니어링 리소스의 15~20%를 기술 부채 해결에 할당한다. - 정기적으로 기술 부채 전용 스프린트를 실행한다. 4️⃣ 능숙한 코드 리뷰 코드를 검토하면 퀄리티 문제를 조기에 발견하고 작성한 엔지니어에게 피드백을 제공할 수 있습니다. - 단위 테스트 통과 - 통합 테스트 통과 - TODO가 없음 - 비즈니스 로직을 코드 주석과 함께 문서화 - 코드 커밋은 커밋 지침을 따라야 함 - 코드 스타일 가이드를 따라야 함 5️⃣ 코드 퀄리티 메트릭 추적 코드 퀄리티 문화를 구축하기 위해서는 코드 퀄리티 메트릭을 추적하는 것이 중요합니다. - 코드 복잡도: 해당 코드가 개발자가 이해하기에 얼마나 복잡한지 알려줍니다. - 코드 1,000줄당 주석: 코드 1,000줄 당 주석 수가 증가한다는 것은 해당 코드를 이해하려면 컨텍스트가 추가로 더 필요하다는 것을 의미합니다. - 코드 결합력: 코드 베이스가 얼마나 잘 구조화되고 조직화 되었는지 측정합니다. 6️⃣ 동료 멘토링 선배 엔지니어들은 긍정적인 문화를 만들고 후배들이 고퀄리티 코드를 작성할 수 있도록 지원해야 합니다. - 지식 공유 - 코드 리뷰 - 코드 페어링