코드 설명은 단순하게 유지해 주세요

• 코드 리뷰에서 긴 설명과 큰 diff가 함께 오면 검토자가 핵심인 변경 이유를 파악하기 어려우므로, 커밋 메시지·머지 리퀘스트 설명·주석은 간결해야 함
• 설명은 무엇이 바뀌었는지보다 왜 바뀌었는지에 집중해야 하며, 많은 변경 내용은 코드 자체로 확인 가능함
• 모든 맥락을 한 번에 담으려는 긴 설명은 일부 검토자의 집중과 리뷰 속도를 떨어뜨릴 수 있음
• 머지 리뷰에서는 원자적 커밋이 특히 중요하며, 작은 수정은 git amend, 병합 전 정리는 rebase나 squash로 처리할 수 있음
• LLM 도구를 쓰더라도 주석·설명·커밋 메시지는 직접 작성하는 편이 코드 이해와 리뷰 접근성에 더 도움이 됨

리뷰 설명은 “무엇”보다 “왜”에 집중

• 코드 리뷰에서 설명, 커밋, 머지 리퀘스트가 과도한 정보로 가득 차면 검토 부담이 커짐
• 변경 내용을 길게 나열하기보다, 핵심은 왜 변경했는지를 분명히 쓰는 것임
• 코드 자체가 대부분의 변경 내용을 보여줄 수 있고, 부족한 맥락은 리뷰어가 질문할 수 있음
• 긴 글처럼 작성된 설명은 집중하기 어려운 사람에게 리뷰를 더 느리게 만들 수 있음
• 커밋 메시지, 머지 리퀘스트 설명, 코드 주석은 명확하고 요점 중심으로 필요한 정보만 담는 편이 좋음

커밋 정리와 LLM 사용에 대한 요청

• 커밋은 머지 리뷰에서 특히 원자적이어야 하며, 각 변경은 독립적으로 이해될 수 있어야 함
• 작은 수정은 git amend로 반영하고, 병합 전에는 rebase로 정리하거나 squash할 수 있음
• LLM 도구를 사용하더라도 주석, 설명, 커밋 메시지는 직접 작성하는 편이 낫다고 봄
  • 직접 쓰는 과정이 변경 내용을 이해하는 데 도움이 됨
  • 직접 작성한 설명이 리뷰어에게 더 접근하기 쉬울 수 있음
• LLM 도구는 가능하면 피하는 편이 낫다는 개인적 의견도 함께 담겨 있음
• 접근성이라는 표현에 대한 반응이 있었지만, 핵심은 코드 리뷰 설명을 더 간결하고 검토하기 쉽게 만들자는 요청임