PR 닫을 때 이유를 같이 남기는 정책

PR을 왜 닫아??

회사에서 작업할때 PR을 close하는 경우가 있다. 정책이 바꼈거나 코드를 잘못 짰거나 등등 여러가지 이유로 PR을 닫는다.

이번에는 백엔드에서 하려던 데이터 정렬 작업을 프런트엔드로 옮겨서, 이 코드를 포함한 PR이 백엔드에서 필요없게 되었다. 따라서 PR을 닫았는데, 사수가 PR 닫을 때는 이유를 comment로 남겨달라고 했다.

왜 comment를 남겨야 할까

comment를 남기는 이유는 간단하다. 나중에 이 PR을 왜 닫았는지 모르니까

예를 들어, PR을 닫고 나중에 들어온 개발자가 PR을 닫은 이유가 궁금해서 질문했을 때, 그 시기가 PR을 닫고 난 6개월 후라면?? 물론 이러한 상황이 많지 않지만(많을 수도 있다…) 인간의 뇌는 생각보다 멍청하다. 따라서 이유를 기록해두어야 나중에 봤을 때 왜 PR을 닫았는지를 알아낼 수 있다. 변경된 코드를 보면 되지 않느냐 라고 반문할 수 있는데, 코드를 봤는데도 기억이 나지 않는다면? 적혀있는 comment를 보고 어떤 코드인지 추적할 수 있다.

기억보다는 기록을

인간의 기억에 의존하는 방법은 실수를 야기한다. (특히 난 멍청하다…) 기록해 놓으면 기억할 필요도 없다. 심지어 기록을 보고 나니 기억이 되살아 날 수도 있다. 특히 PR을 닫는 경우는 예시와 같이 정책이 바뀐 경우가 빈번하므로, comment에 바뀐 정책에 대해 간략히 써놓으면 회사 정책의 변화 과정도 되짚어 볼 수 있다.