본문 바로가기
Git

코드리뷰 약어 살펴보기

by codeyaki 2023. 8. 4.
반응형

사이드 프로젝트를 진행하고 있는 팀원들과 코드리뷰 아닌 코드리뷰를 진행하고 있는데 그동안은 정해진 규칙 없이 아무렇게나 작성하곤 했다. 그러다 보니 중요한 코멘트와 중요하지 않고 단순 의견임을 나태내기 어렵다는 생각이 들기 시작했다. 때로는 잘 작성한 것 같아 그냥 “수고하셨습니다.”만 날리곤 했다.

따라서 코드리뷰에서 주로 사용한느 약어들을 정리하여 실제로 사용보면 어떨까 하여 알아보았다.

CL (ChangeList)

코드 변경 단위, 변경된 코드 리스트

NIT (NITpicking)

중요하지는 않지만 더 나은 방법이 있다는 의견 (TMI와 비슷한 느낌이다.)

LGTM (Look Good To Me)

내가 보기엔 좋아보여라는 뜻으로 문제가 없어 보일 때 사용한다

비슷한 말로 (SGTM (Sounds Good To Me)가 있다.

ACK (ACKnowledgement)

승인을 남길때 사용한다. 하지만 단순히 ACK만 쓰면 어떻게 리뷰를 진행한 건지 알 수 없기 때문에 섬세하게 구분하여 사용하기도 한다고 한다.

  • Concept ACK
  • 아이디어와 전반적인 방향에 대해 동의, 하지만 코드를 확인하거나 테스트를 해보진 않았음
  • utACK (Unteted ACK)
  • 코드는 확인을 했지만 테스트는 따로 해보지 않았음
  • tested ACK
  • 검토도 했고, 테스트도 했음

NACK/NAK (Negative Acknowledgement)

승인을 거절할 때 사용한다.

거절할 때는 왜 거절했는지에 대한 이유를 함께 적어줘야함

RFC (Request For Comments)

의견을 요청할 때 사용

WIP (Work In Progress)

아직 작업 중 (병합하지 않았을 때 사용)

AFAIK/AFAICT (As Far As I Know / As Far As I Can Tell)

내가 알기론… / 내가 말할 수 있는 건…

의견 내기 전 접두어처럼 사용

IIRC (If I Recall Correctly)

내 기억이 맞다면 …

의견 내기전 접두어처럼 사용

IANAL (I Am Not A Lawyer)

나는 변호사가 아니다.

자신의 말에 법률 자문을 제공하기 전 자신이 변호사가 아니니 주의하란 말

비슷한 말로 TINLA (This Not Legal Advice)

IMO (I My Opinion)

개인적으로 …

의견 내긴 전 접두어처럼 사용

좀 더 격식을 차린 말로 IMHO (In My Humble Opinion)가 있다.

FYI (For Your Information)

참고로 ~

비슷한 말로 FYR (For Your Reference)가 있다.

PTAL (Please Take a Look)

이거 좀 확인해 주세요, 다시 한번 확인해 주세요.

SSIA (Subject Says It All)

타이틀만 봐도 전부 이해할 수 있다.

TBD (To Be Determined)

곧 결정하겠다.

TL;DR (Too Long; Didn’t Read)

너무 길어서 안 읽음

반응형