커밋명과 설명을 명확하게 작성하자

junhyeong·2022년 11월 16일
0

오늘은 동기들과 서로의 코드에 리뷰를 다는 시간을 가졌다.

사실 일요일부터 만들었기에 이전에도 리뷰를 할 수 있었지만 이번주는 서로 상황이 안맞아서 오늘에서야 하게 되었다.

4일치를 한번에 봤더니

서로 한명씩 지정해서 코드를 확인했다. 그런데 역시 4일치라 그런지 코드양이 만만치 않았다. 평소처럼 5분정도 잡고 했더니 끝까지 볼 수도 없었고, 보고 싶은 의욕도 떨어졌다.

커밋별로 리뷰하기(기능별로)

너무 비효율적이라는 생각이 들어서 기능별로 리뷰를 하기 위해 커밋을 확인해봤다. 그런데 동기의 커밋은 기능별로 저장되어있지 않아서 그냥 보는거랑 다를게 없었다.

나는 커밋명과 설명을 잘 작성하고 있을까

일단 동기의 코드에 커밋을 기능별로 나누면 더 좋을 것 같다는 리뷰를 달고, 나는 커밋명을 잘 작성하고 있나 생각해보았다.

'상품목록확인 구현' 이런식으로 기능별로 나누긴 했는데 추가 설명이 없는게 아쉬웠다. 설명이 있었다면 내 의도에 맞게 코드가 작성되었는지 파악하기 수월했을 것이다.

앞으로는 내가 어떤 의도로 무얼 작업했는지 커밋명과 설명에 드러나게 작성해보자

Action
내가 어떤 의도로 무얼 작업했는지 커밋명과 설명에 드러나게 작성하기

profile
매일매일이 성장하는 하루가 될 수 있도록!

0개의 댓글