[CS Knowledge] 협업에 관하여.. 좋은 코드 리뷰, 좋은 PR, 좋은 PR Review...

코딩 컨벤션 참조하기 좋은 사이트

https://ui.toast.com/fe-guide/ko_CODING-CONVENTION

코딩컨벤션

 

전 게시물에서도 언급을 했지만 개발자로써의 협업의 목표는 

1. 안전한 개발

2. 개발 생산성 증대

좋은 협업 프로세스가 갖춰진 집단이나 조직은 -> 안정성과 생산성을 증대시킨다.

 

1. 코딩 스탠다드 정하기 

5가지 원칙

1. 실수하지 않게끔 예방

2. 실수했더라도 최대한 빨리 찾아야함

3. 시간을 너무 낭비하지 않기 

4. 인간의 평균 지적 수준으로 잘 이해할 수 있는가

5. 문제가 발생하는 곳이 바로 보여야한다

 

각 조직과 각 팀원에 맞게 잘 녹여서, 높은 설득력과 말하는 화자의 각 개인의 노력이 더욱 더 필요하다.

 

2. 좋은 PR(Pull Resquest) 작성하기 

10줄 짜리 코드에서는 10가지 이슈가 발견이 되는데, 500, 1000줄 라인이 넘어가는 코드는 아무도 읽지 않는다. 

코드 review는 항상 reviewer가 있다. 즉 좋은 pr리뷰는 읽는 사람을 고려하여 , 작은 pr을 작성하고, 작은 단위의 의미있는 commit을 추가해두어야한다.

3. PR 템플릿 만들기 (reviwer를 고려하려 템플릿을 통해 간결하고, 깔끔하게)

• Background : 이 PR에 어떤 작업이 포함됐는지에 대한 내용을 요약합니다. 관련 문서, 작업 티켓, 디자인 가이드 등의 문서도 링크합니다.
• Important : 리뷰어에게 전달하거나 논의하고 싶은 내용을 기재합니다.
• Changes : 주요 수정 사항을 기재합니다. 핵심 수정사항은 커밋 Hash와 함께 기재하는 편이며, 리뷰어가 이해하기 어려울 것 같은 부분에 추가 코멘트를 작성하기도 합니다.
• Test Guide : 이 작업을 테스트하기 위한 방법을 기재합니다. UI 작업이 병행된 경우 전/후 스크린샷을 첨부하기도 합니다. // 리뷰어 명시

 

4. 라벨 활용하기

버그 수정, 보류 중, 진행 중, self approved 같은 라벨 활용하기 

5. 내가 먼저 PR 리뷰하기 

질문을 남기고 싶은 곳에 먼저 질문 등록해두기, 리뷰 테스트 받고 싶은 곳에 먼저 리뷰 요청 해두기 

 

 

6. 좋은 코드 리뷰 시작하기

1. 개선점 이야기 하기 

2. 칭찬하기

3. 설명 요청하기

4. LGTM 

고생했습니다. 감사합니다.. 같은 의미인가보네요. 

개발자 무플방지...