PR 리뷰 작성법

gak·2023년 1월 2일
0

PR 리뷰 작성법

import 가 올바르게 되어 있는가?

/shared 에 있는 파일에서 /editor 의 파일을 참조하고 있는지?


사이드이펙트는 없는가?

Undefined, null 가능성이 있는 변수에 매서드를 실행시키는 경우


네이밍이 올바른가?

네이밍 규칙을 잘 지키고 있는지

e.g) 파스칼, 카멜케이스 준수 여부

변수의 의미에 맞는 네이밍을 사용하고 있는지

e.g) 타입이 number[] 인데, 변수 이름은 단수일 경우 의미상 맞지 않음. → 변수 이름이 복수형이어야함.


코드의 스타일링이 적절한가?

코드에 eslint 스타일링이 잘 적용되었는지

코드에 의미없는 개행이 없는지


이 구조가 최적의 구조인가?

의존성이 적은지?

코드를 이해하기 쉬운지?

Anti-pattern

  • 버그를 잘 일으키는 구조.
  • 한 군데를 바꾸면 다른 곳도 바꿔줘야하는 귀찮고 의존을 많이하는 구조인지
  • 밀집도가 높은 구조 (이러면 코드를 읽기 너무 어려움..)
  • 설계를 하지 않고 주먹구구식으로 짠 코드 → 읽는 사람이 이해하기 너무 힘듦, 성능 안좋아짐.

좋은 코드란?

  • 이해하기 쉬운 코드 제일 중요한듯!
  • 알맞은 디자인패턴이 적용된 코드
  • 순차적인 과정을 포함하는 논리가 있으면 설명하기도 쉽고 이해하기도 쉬운 코드를 짤 수 있는 것 같음.

profile
Hello. I'm Front-End Developer Trying to Create Valuable Things.

0개의 댓글