검토시 칭찬합시다

포에미한 기사입니다.

리뷰

웹 기반 기업에서 코드를 작성하는 작업을 수행하는 경우 동료의 코드 검토를 자주 해야 합니다.
그래서, 리뷰시에 「아, 이 코드 좋구나」라고 생각하는 일은, 자주 있지요.

예를 들어 언어 기능을 훌륭하게 다루는 코드.

예를 들어 도메인을 아름답게 알기 쉽게 표현한 코드.

예를 들어 잘 구조화된 견고하고 변경하기 쉬운 코드.

예를 들어 알기 어려운 예외적 사건에 올바르게 대처한 코드.

그, 「아, 이 코드 좋구나」라고 하는 기분, 제대로 표현합시다.
마음 속에서 생각하는 것만으로는 전해지지 않습니다.

칭찬하다

GitHub을 사용하여 코드를 관리하고 검토하는 경우 좋다고 생각한 부분의 코드에 그 취지를 코멘트합시다.

xxx 関数を使って綺麗に処理している :+1:

xxx と ooo をきちんと分けているのは good

xxx の処理を切り出して private method にしているのとても分かりやすい！

xxx の場合にちゃんと対処している :heart:

왜 좋다고 생각했는지, 어떻게 좋다고 생각했는지, 짧게 설명하면 보다 좋은 인상이겠지만, 이나 뿐이라도 문제 없다고 생각합니다.
리뷰의 사내 룰로 코멘트에 지적 이외를 남길 수 없다고 한다면, 사내 채팅으로 「여기 좋았어」라고 전하는 것도 좋을 것입니다.
어쨌든, 제대로 말을 꺼내 상대에게 전하는 것이 중요합니다.

요약

리뷰는 코드의 품질을 유지하기 위한 중요한 작업입니다만, 그렇다고 해도, 잘못된 점 좋지 않은 점의 지적만을 받고 있으면 기분도 고조되지 않을 것입니다.
물론 문제점의 지적은 중요합니다. 그러나 그러한 개선점만큼이나 좋은 점 멋진 점도 있을 것입니다.
그런 부분을 제대로 말로 칭찬하는 것으로, 코드를 쓰는 것의 기쁨을 조금이라도 늘릴 수 있습니다.

부차적인 효과로서 팀 내에서 코드의 지침을 귀납적으로 구축할 수 있다는 면을 들 수 있을지도 모릅니다.
원하는 코드란 어떤 코드인지, 실례를 쌓아 올리는 것도, 코드의 품질 향상에 연결될 것이기 때문입니다.

왜 이런 기사를 썼는지

위에서 꼽은 것과 같은 일, 스스로도 할 수 없었구나 라고 항상 생각하고 있었으므로, 반성과 자계를 위해서 썼습니다.