yoon-jj의 블로그
Github를 둘러보다보면 보이는 약어들.. 본문
회사에서 코드 리뷰를 받던 중 리뷰에 처음 보는 단어가 적힌 것을 보고 무슨 뜻인지 몰랐던 적이 있다.
어떤 내용을 수정하는 것도 좋을 거 같다는 이야기였는데 말과는 반대로 승인은 되어있었다.
좋다는 건지 나쁘다는 건지.. 알 수 없어 NIT라는 것이 무슨 말인지 구글에 검색해보았으나..
NIT라고만 검색하면 안 나오는듯하여 NIT github와 같이 검색하니 원하던 뜻을 알 수 있었다.
nit은 이(머리에 있는 벌레..머릿니)나 기생충의 알을 뜻하는데, 여기서 나온 nitpicking이라는 단어가 있다.
생산적이지 않은 것에 너무 신경을 쓰는 행동을 뜻한다.
코드 리뷰에서는 이를 줄여 NIT이라고 하며, 중요하지는 않지만 의견을 남기고 싶을 때 사용하는 말이라고 한다.
검색을 하다가 이 외에도 코드리뷰에서 사용하는 여러 단어들이 있다는 것을 알게 되었고 다른 것들에 대해 더 알아보기로 했다.
NIT
중요하지는 않지만 더 나은 방법이 있다는 의견을 남기고 싶을 때 사용한다.
LGTM (Look Good To Me)
코드가 문제가 없이 나에겐 좋아보인다. = 승인!
ACK (Acknowledgement)
승인을 남길 때 사용한다.
그런데 ACK라고만 남기면 코드만 확인한 건지, 테스트까지 해본 것인지, 코드 안 읽고 그냥 승인한건지.. 확실하지 않기 때문에 앞에 추가적인 말을 붙여서 아래와 같이 사용한다고 한다.
- Concept ACK
아이디어와 전반적인 방향에 대해 동의는 하는데, 코드를 확인하거나 테스트를 해보진 않았다.
- utACK (Untested 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 is Not Legal Advice)가 있다.
IMO (I My Opinion)
개인적인 의견이지만..
어떤 의견을 낼 때 앞에 접두어처럼 사용한다.
FYI (For Your Information)
직역하면 당신의 정보를 위해서, 의역하면 참고로라는 뜻이다.
상대가 알아야 하는 내용을 전달할 때 사용하며, FYI 다음에는 어떤 주제에 대한 정보가 온다.
비슷한 말로 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)
너무 길어서 안 읽었다.🤭
NIT는 그럴듯했는데, 더 찾아보다 보니 코드 리뷰할 때 이런 말(TL;DR, IANAL..)을 정말 쓴단 말이야? 싶은 말들이 좀 있었다.
(IANAL는 그렇다고 쳐도 길어서 안 읽었다.라는 말을..? 쓴다고..? 안 읽었으면 그냥 넘어가지 왜 댓글을 남기는 거지..?)
코드 리뷰가 아니라 인터넷 댓글에서나 볼법한 거 아닌가 싶어서 "용어 github"로 검색해봤는데 꼭 코멘트뿐만 아니라 PR의 제목으로 사용하거나, 문서를 남길 때 사용하는 것들도 있었다.
일단은 코드 리뷰용으로 알아보긴 했지만, 몇 가지는 일상에서도 사용하는 약어들이라고 하니 잘 기억해뒀다가 나중에 써먹어봐야겠다.
참고
What do cryptic Github comments mean? - Alex Beregszaszi
github comment - fanquake
'개발 > 기타' 카테고리의 다른 글
방통대 3학년 1학기 (0) | 2023.06.21 |
---|---|
SQLD + 보수교육 (0) | 2022.01.30 |
CSR과 SSR (0) | 2021.10.11 |