8 Code Principles for Saner Development

카테고리

프로그래밍/소프트웨어 개발

서브카테고리

개발 툴

대상자

• 중급 이상의 개발자 및 협업 팀 구성원
• 협업, 코드 가독성, 문제 해결 전략에 초점을 맞춘 실무 지침

핵심 요약

• "다른 사람이 유지 보수할 코드를 작성하라"
• 코드의 가독성과 유지 보수성을 위해 복잡한 구현보다 명확함을 우선시해야 함
• "짧은 커밋 메시지와 원칙적인 코드 작성"
• "wip"으로 300줄 이상의 커밋을 피하고 작은 단위의 의미 있는 변경사항을 반영
• "Five Whys 기법으로 근본 원인 파악"
• "왜?"를 5회 반복해 문제의 근본 원인을 탐색함으로써 반복적 버그를 방지

섹션별 세부 요약

1. 코드는 유지 보수를 위해 작성된다

• "다른 사람이 유지 보수할 코드를 작성하라"
• 코드가 복잡해질수록 다른 팀원 또는 미래의 자신을 고려해야 함
• "복잡한 코드는 혼란을 일으키며, 명확함이 협업의 기반이다"
• Slack 메시지나 다이어그램이 필요할 정도로 복잡한 코드는 리팩토링 필요

2. 명확성과 협업 중심의 개발

• "코드는 협업을 가능하게 하며, 혼란을 줄이는 것이 중요하다"
• "10x 개발자 느낌을 주지만, 다른 사람에게 이해되지 않는 코드는 리팩토링 필요"
• "Jira 티켓의 모호함을 제거하고, 개발 전 목표와 범위를 명확히 정의"

3. 커밋 메시지와 코드 리뷰를 위한 전략

• "명확한 커밋 메시지는 팀원과의 커뮤니케이션을 향상시킨다"
• "PR을 신입 개발자가 이해할 수 있도록 설명"
• "대규모 PR은 리뷰와 디버깅에 어려움을 줄 수 있으므로, 작은 단위로 분할"

4. 문제 해결의 근본 원인 탐색

• "Five Whys 기법은 반복적 버그를 방지하고, 시스템 이해를 돕는다"
• "문제의 표면 현상(예: 드롭다운 오류)보다 원인(예: 엔드포인트 미구현)을 우선 파악"
• "이 기법은 PM, 디자이너와의 커뮤니케이션을 명확하게 하며, 기술적 이해를 깊게 해준다"

결론

• "코드는 협업과 유지 보수를 위한 도구이므로, 명확성과 원칙을 바탕으로 작성해야 한다"
• "Five Whys 기법과 작은 단위 커밋은 팀의 협업 효율성과 장기적인 유지 보수를 극대화하는 핵심 전략"
• "모든 원칙을 완벽하게 적용할 필요는 없지만, 개발자로서의 책임감과 팀워크를 강화하는 데 기여"