TIL 코드 리뷰의 중요성(11/11)

임기철·2024년 11월 11일
0

TIL

목록 보기
42/46

회고록

오늘은 코드 리뷰를 통해 전체적으로 수정할 부분을 수정하였다.

1. Speak 컴포넌트에서 사용하는 audio api에서 사용하지 않는 주석과 불필요한 코드를 줄이기 위해 삭제 및 함수를 선언해서 깔끔하게 보이게 다시 작업하였다.

Before

After

코드가 한눈에 간결해진게 보였으며 어떤 부분이 에러가 생길지 더 잘보이게 되었다.

2. 자주 실수하는 주석과 변수명같이 규칙에 대해 리뷰때 지적을 많이 받았다.

  • hook은 use~~를 붙이자
  • console.log는 앞으로 해야 할 거에 대한 내용을 위주로 적어둔다 (불필요한 console 제거)
  • 함수 명은 목적에 따라 명시적으로 확인하기 편하게 적어주자 (데이터 통신 get, 이벤트 핸들러 handle)
  • reactQuery를 사용한다면 팀원들 전부 쿼리를 사용하는게 좋다
  • mutation을 사용할때 어떤거는 update 어떤거는 mutate를 사용하는건 좋지 않다고 들었다

이러한 사소한게 많이 겹치다 보니 코드가 내부적으로 많이 깔끔하지 않았던거 같다.
리뷰를 통해 코드를 다시 되돌아 볼 수 있어서 좋았고 내가 몰랐던 지식들도 알게되는 시간이였던거 같아서 알찼던 시간이였다.

3. Github에서 PR과 코드 리뷰는 필수로 하자

  • 코드 리뷰를 하면서 중첩 코드가 많았는데 이러한 부분이 각자 리뷰를 하면서 PR을 해주었다면
    조금 더 중복 코드 없이 깔끔해질수 있었을거 같다는 생각이 들었다

  • 코드 리뷰를 하다보니 문법적으로 틀린것이 있었지만 PR 확인때 잡지 못해서 한소리 들었버렸다
    이렇게 코드 리뷰의 중요성을 다시 깨닫는 계기가 된 거 같다

  • 통일성 있게 PR 이름이라던가 그 안에 있는 내용이 하나로 맞춰야 같이 하는 프로젝트라는 느낌을 받는다는걸 알게 되었다 확실히 처음에는 몰랐지만 지금까지 PR한 기록을 보니 각자 다른다는걸 알게 되었고 지금이라도 맞추기로 하였다.

    코드 리뷰를 한다고 거창한게 아니라 간단한 리뷰도 충분하다는걸 알게 되었고 엄청나게 도움 된다는것을 알게 되었다 조금씩 하다보면 나중에는 엄청나게 큰 도움이 될 걸 알기에 지금이라도 시작행야 할 거 같다

0개의 댓글

관련 채용 정보