코딩 컨벤션 정하기
코딩 컨벤션 필요한가?
- 회사에서 신규 언어로 개발을 하면서 사내 컨벤션의 요구가 생기게 되었다.
- 보통 많이쓰이는 언어 스타일 가이드가 있으니 따르면 되지 않나 생각했지만 사람마다 의견이 달랐다. 너무 제약사항이 많으면 안좋다고 생각하지만 최소한 개발 규칙을 위한 합의가 필요했다.
아키텍쳐 논의?
- 시작은 패키지명부터? 단순 코딩 컨벤션인줄 알았는데 패키지명 이야기가 나오니 아키텍처 이야기가 안나올 수 없었다. 레이어드 아키텍쳐, 도메인 중심 패키지 같은 이야기도 나오고 여기서 회사의 적절한 구조는 무엇일지 이야기도 나누었다.
핫스팟
- 특정 언어 컨벤션을 정하기 위해서 사내 회의에서 잡았는데, 언어를 불문하고 공통적으로 처리해야할 규칙들의 논의가 필요했다. 요청, 응답과 REST 규칙같은 것들은 추후 공통 규칙 회의에서 정하기로 했다.
API 문서화
- 생각보다 여기서도 이야기가 많았다. 실제 운영 코드에 문서 기능을 추가하자는 의견과 테스트 코드를 통한 문서 기능을 추가하는 이야기가 있었다. 나는 테스트 코드에서 추가하기를 원했지만 생각보다 반대의견이 많았다. 다른 사람들의 의견도 나름 합리적이었고, 다수결로 코드에서 문서기능을 추가하는 것으로 결정했다.
컨벤션을 정하면서 얻은 장점
- 코드리뷰에서 나올 이야기들의 룰을 미리 세울 수 있었다.
- 특정 직원이 아니라 서로가 합의해서 나중에 생길 불만을 줄일 수 있을 것같다.
- 컨벤션을 정하면서 개발에 대한 생각을 어느정도 들을 수 있었다.
미래 계획
- 논의할 부분에 대해 예시 코드를 준비해서 장단점을 설명하면 다른 직원들을 설득하기 더 좋지 않을까?
- 주제에 대해 더 조사해보자.
노력하는 개발자입니다!