TIL - 20220601

 어제 작성한 Commit 메시지에 다음과 같은 피드백을 받았다.

테스트 코드를 추가하는 Commit 메시지를 작성하면서 어차피 소스 코드 보면 알 수 있으니까 테스트 코드를 추가했다는 정도만 작성하면 되겠지라는 막연한 생각을 갖고 있었는데, 생각해보면 테스트 코드 또한 어떤 것을 테스트하고 싶은지 그 이유를 명확하게 적어놔야 협업할 때 테스트 코드를 작성한 이유에 대해 물어보지 않을 것이니까 앞으로 테스트 코드도 왜 이러한 테스트 코드를 적었는지 의도를 좀 더 생각하고 자세히 적는 습관을 가져야겠다.

 

 그리고 Commit 메시지를 작성하다 내가 지금 잘못 작성하고 있는 거 같은데라고 느낀 지점이 있다.

https://jason-api.tistory.com/89 를 참고하여 Commit 메시지 제목을 작성할 때, 여러 종류가 있다. 어제 Commit 메시지를 처음 제대로 작성해보면서 내가 한 행동이 크게 Feat, Refactor, Test, 이 세 가지였기 때문에 소스 코드를 작성하면서 만난 에러 해결은 Fix로 분류하는 것이 맞는데 그냥 코드를 수정하니까 Refactor~라고 생각하고 있었다. 다행히(?)도 작성하면서 나 스스로 제목을 잘못 작성한 것 같은데라고 느껴서 바로 다음부터는 Fix로 제목을 설정했다. 이 외에도 문서를 수정할 때 제목은 DOCS, 스타일을 수정할 때 제목은 STYLE, 그 외에 빌드나 패키지 수정은 CHORE이니깐 제목의 분류도 생각 없이 나누지 말고 정확하게 나눠주어야겠다고 생각한 하루였다!