코드 리뷰 규칙 - linewalks/dev-common GitHub Wiki

우선 순위 규칙

• 리뷰의 우선순위를 빠르게 파악하기 위함
• 리뷰 댓글은 p1 ~ p5로 시작

P1

• 반드시 반영해주세요
• 버그가 예상되거나 잘못 구현된 것
• 예시
  • A가 없다면, B가 define되지 않아 아래에서 에러가 날 것 같아요.
  • EE는 클라이언트에서 서버로 보내고 있는 변수에요. 없애면 에러가 날 거에요.
  • 데이터 추출이 잘못되고 있어요.

P2

• 반영해주세요. 안 된다면 논의해요.
• 명시된 규칙을 지키지 않은 것
• 더 효율적인 방법이 있는 것
• 유지보수를 힘들게 만드는 것
• 예시
  • 여기선 double quote가 사용되어야 해요.
  • 변수 이름에 오타가 있어요.
  • 요소가 많아지면 비효율적이 될 거에요. array대신 dictionary를 사용해보아요.

P3

• 다른 이슈나 PR에서 반영해도 돼요 or 전 다른 의견이에요.
• 대규모 수정을 요하는 리팩토링
• 논의가 필요한 것
• 예시
  • dependency를 빼도록 테스트를 수정하면 좋겠어요.
  • 이전 코드가 더 좋은 방법이라고 생각해요. 이유는 어쩌고저째서에요.

P4

• 반영하지 않아도 상관없어요.
• 효율성이나 유지보수에 큰 영향을 주지 않는 것
• 예시
  • ABC를 D로도 간단하게 쓸 수있어요. D 함수의 내부 구현은 크게 다르지 않을 거에요.
  • 변수 이름을 ABCD에서 ABCE로 바꾸는 게 더 보기 좋을 것 같아요

P5

• 요구가 아니에요
• 사소한 의견, 질문, 칭찬, 감탄
• 예시
  • 이렇게도 할 수 있군요!
  • 이렇게 수정하신 이유가 무엇인가요?
  • 코드가 아주 깔끔해졌습니다.