코드 리뷰 가이드라인

GitLab CE 및 EE의 머지 리퀘스트 코드 리뷰 프로세스, 역할별 책임, 승인 가이드라인, 모범 사례를 설명합니다.

GitLab CE와 EE의 모든 머지 리퀘스트는 코드가 효과적이고 이해하기 쉬우며 유지 보수가 가능하고 안전한지 확인하기 위해 코드 리뷰를 거쳐야 합니다. 머지 리퀘스트 리뷰, 승인, 병합 받기 # 시작하기 전에 기여 승인 기준 을 숙지합니다. 코드는 소속 그룹의 리뷰어 또는 도메인 전문가 에게 리뷰를 받습니다. 작고 단순한 변경 사항이라면 리뷰어 단계를 건너뛰고 곧바로 메인테이너 에게 전달할 수 있습니다. 작고 단순한 변경 사항의 예는 다음과 같습니다. 오타 수정이나 간단한 문구 변경. 동작을 바꾸지 않는 소규모 리팩토링. 한 달 이상 기본값으로 활성화되어 있던 기능 플래그 제거. 사용하지 않는 메서드나 클래스 제거. 다섯 줄 미만의 코드 변경으로 끝나는, 충분히 이해된 로직 변경. 그 밖의 경우에는 MR 이 건드리는 카테고리 별로 리뷰어를 지정한 뒤 메인테이너에게 전달합니다. 보안 관련 지원이 필요하면 @gitlab-com/gl-security/appsec 을 포함합니다. 리뷰어가 승인하면 메인테이너가 리뷰한 뒤 병합합니다. 마지막 필수 승인자가 병합합니다. CODEOWNERS가 요구하는 승인은 일반 승인보다 도메인별 승인을 먼저 받습니다. 도메인별 승인자가 메인테이너를 겸하는 경우 두 관점을 함께 리뷰하고 한 번만 승인합니다. 승인 가이드라인 # 아래 메인테이너의 책임 절에서 설명하듯이 머지 리퀘스트는 도메인 전문성 을 갖춘 메인테이너가 승인하고 병합하도록 하는 것을 권장합니다. 첫 리뷰어의 선택적 승인은 여기서 다루지 않습니다. 다만 머지 리퀘스트는 메인테이너에게 전달하기 전에 개요 절에서 설명한 대로 리뷰어의 리뷰를 받아야 합니다. 머지 리퀘스트에 포함된 내용 필요한 승인자 ~backend 변경 사항 1 백엔드 메인테이너 . ~database 마이그레이션 또는 비용이 큰 쿼리 변경 사항 2 데이터베이스 메인테이너 . 자세한 내용은 데이터베이스 리뷰 가이드라인 을 참고합니다. ~workhorse 변경 사항 Workhorse 메인테이너 . ~frontend 변경 사항 1 프론트엔드 메인테이너 . ~UX 사용자에게 보이는 변경 사항 3 Product Designer . 자세한 내용은 디자인 및 사용자 인터페이스 가이드라인 을 참고합니다. 새 JavaScript 라이브러리 추가 1 - 라이브러리가 번들 크기 를 크게 늘리는 경우 Frontend Design System 구성원 . - 새 라이브러리가 사용하는 라이선스가 GitLab에서 사용 승인을 받지 않은 경우 법무 부서 구성원 . 라이선스 호환성에 대한 자세한 내용은 GitLab 라이선스 및 호환성 문서 에서 확인할 수 있습니다. 새 의존성 또는 파일 시스템 변경 - Distribution 팀 구성원 . 자세한 내용은 Distribution 팀 과 협업하는 방법을 참고합니다. - RubyGems의 경우 AppSec 리뷰 를 요청합니다. ~documentation 또는 ~UI text 변경 사항 해당 DevOps Stage 그룹 의 배정에 따른 테크니컬 라이터 . 개발 가이드라인 변경