InfoGrab DocsInfoGrab Docs

Python 머지 리퀘스트 가이드라인

요약

GitLab 표준 코드 리뷰 가이드라인은 Python 프로젝트에도 동일하게 적용됩니다. GitLab에서 Python 코드 리뷰 프로세스를 설정하는 데는 두 가지 주요 방법이 있습니다: 대규모 프로젝트: 대형 Python 프로젝트는 일반적으로 reviewer-roulette를 통해 자체 전담 리뷰어 풀을 보유합니다.

GitLab 표준 코드 리뷰 가이드라인은 Python 프로젝트에도 동일하게 적용됩니다.

Python 코드 리뷰 프로세스 설정 방법#

GitLab에서 Python 코드 리뷰 프로세스를 설정하는 데는 두 가지 주요 방법이 있습니다:

  • 대규모 프로젝트: 대형 Python 프로젝트는 일반적으로 reviewer-roulette를 통해 자체 전담 리뷰어 풀을 보유합니다. 설정 방법은 Reviewer Roulette 설정을 참조하세요.

  • 소규모 프로젝트: 기여자가 적은 프로젝트의 경우, GitLab 전반에 걸친 Python 리뷰어 공유 풀을 유지합니다.

Reviewer Roulette 설정#

이 섹션에서는 프로젝트를 reviewer roulette 및 기타 리소스와 통합하여 프로젝트 기여자와 Python 전문가를 코드 리뷰에 연결하는 방법을 설명합니다.

대규모 및 소규모 프로젝트 모두에서 Reviewer Roulette는 리뷰어 배정 프로세스를 자동화할 수 있습니다. 설정 방법:

그런 다음, 프로젝트 규모에 따라:

  • 기여자가 충분한 대규모 프로젝트의 경우:

자격을 갖춘 팀 멤버는 team_members 또는 team_database의 개인 항목에 있는 projects 필드에 Python 프로젝트를 추가하고, 리뷰어 또는 메인테이너와 같은 적절한 권한을 지정해야 합니다.

  • 프로젝트에 개별 roulette 구성을 추가합니다.

  • 소규모 프로젝트(예: 기여자가 10명 미만)의 경우:

프로젝트에 공유 풀 구성을 추가하여 회사 전체의 Python 전문가 풀을 활용합니다.

  • 필요한 경우 기여자 또는 비도메인 리뷰어가 도메인 전문 지식을 위해 팀 Slack 채널에서 도움을 요청하도록 권장할 수 있습니다.

머지 리퀘스트가 생성되면, Review Roulette가 구성에 따라 자격을 갖춘 리뷰어를 무작위로 선택합니다.

추가 권장 사항#

자세한 내용은 reviewer roulette를 참조하세요.

도움 요청#

기여자에게 Python 관련 리뷰에 대한 질문이 있거나 추가적인 도움이 필요한 경우, 지원을 위해 GitLab #python 또는 #python_maintainers Slack 채널로 안내하세요.

Python 메인테이너가 되는 방법#

대규모 프로젝트에는 자체 리뷰어 및 메인테이너 풀이 있습니다. 소규모 또는 신규 프로젝트는 GitLab의 기존 Python 전문가의 도움을 활용할 수 있습니다.

GitLab Python 전문가#

GitLab Python 전문가는 다양한 프로젝트에서 코드 품질 향상에 기여하는 Python 전문 지식을 보유한 전문가입니다. 전문가가 되려면:

  • team 파일의 projects 아래에 python: maintainer 역량을 추가하는 머지 리퀘스트를 생성합니다.

  • 이 템플릿을 사용하고 설명된 프로세스를 따릅니다.

머지 리퀘스트가 병합되면 Python 메인테이너 그룹에 추가됩니다.

특정 프로젝트의 리뷰어 및 메인테이너#

각 프로젝트는 자체 리뷰 프로세스를 수립할 수 있습니다. 자세한 내용은 메인테이너십 가이드라인을 검토하거나 현재 메인테이너에게 문의하세요.

메인테이너 책임#

코드 리뷰 외에도, 메인테이너는 아키텍처 결정을 안내하고 GitLab.com에서 도입된 관련 엔지니어링 사례를 모니터링하고 Python 프로젝트에 적용할 책임이 있습니다. 이를 통해 Python 프로젝트가 회사 표준과 일관성을 유지하고 부합하도록 보장합니다. 일관성을 유지하면 GitLab.com과 Python 프로젝트 간의 전환이 단순화되고 컨텍스트 전환 오버헤드가 줄어듭니다.

메인테이너의 기술적 전제 조건:

  • 특정 프로젝트에서 사용되는 Python 프레임워크에 대한 강력한 경험. 일반적으로 사용되는 프레임워크에는 FastAPI 및 Pydantic 등이 있습니다.

  • 고급 테스트 전략(예: 모킹, 통합 테스트, 테스트 주도 개발)을 포함하여 pytest와 같은 Python 테스트 프레임워크에 대한 숙련도.

  • 하위 호환성 고려 사항에 대한 이해(Work item).

코드 리뷰 목표:

  • 변경 사항이 스타일 가이드(Work item) 및 프로젝트의 기존 패턴을 준수하는지 확인합니다.

  • 해당하는 경우, 머지 리퀘스트에서 도입된 변경 사항에 대해 테스트 커버리지가 추가되었는지 확인합니다.

  • 성능 영향 검토.

  • 보안 취약점 확인.

  • 기존 시스템에 대한 코드 변경 영향 평가.

  • 머지 리퀘스트에 올바른 MR 유형 라벨이 있고 현재 마일스톤에 할당되어 있는지 확인합니다.

추가 책임:

  • 정확하고 완전한 문서 유지.

  • 필요에 따라 패키지 의존성 모니터링 및 업데이트.

  • 다른 엔지니어에게 Python 모범 사례 멘토링.

  • 새로운 도구 및 라이브러리 평가 및 제안.

  • 성능 모니터링 및 최적화 제안.

  • 보안 표준 유지 보장.

  • GitLab.com에 도입된 관련 엔지니어링 사례를 정기적으로 모니터링하고 적용하여 프로젝트가 GitLab 표준과 일관성을 유지하고 부합하도록 보장.

  • 명확한 코드 리뷰 프로세스 수립 및 시행.

코드 리뷰 모범 사례#

코드를 작성하고 리뷰할 때 스타일 가이드를 따르세요. 코드 작성자와 리뷰어는 다음 영역에 주의를 기울이도록 권장합니다.

리뷰 집중 영역#

GitLab에서 Python 코드를 리뷰할 때 다음 영역을 고려하세요:

1. 코드 스타일#

  • 코드가 합의된 Python 포맷팅 표준을 따르는지 확인합니다(파이프라인에서 적용됨).

  • 명명 규칙이 명확하고 설명적입니다.

  • 모든 공개 함수 및 클래스에 docstring이 사용됩니다.

2. 코드 품질#

  • 함수가 집중적이고, 과도하게 복잡하지 않으며, 테스트 가능합니다.

  • 과도한 주석 없이 코드가 읽기 쉽습니다.

  • 미사용 코드나 주석 처리된 코드가 없습니다.

3. 테스트#

  • 새 코드에 대한 테스트 커버리지가 충분합니다.

  • 테스트가 test_{file_being_tested}.py 명명 규칙을 따릅니다.

  • 외부 의존성에 대해 모킹이 적절하게 사용됩니다.

4. 문서화#

  • 함수와 클래스에 명확한 docstring이 있습니다.

  • 복잡한 로직에는 설명 주석이 있습니다.

  • 기능 추가 시 문서가 업데이트됩니다.

5. 보안#

  • 코드가 GitLab 보안 가이드라인을 따릅니다.

  • 입력값이 올바르게 검증됩니다.

  • 오류 처리가 적절합니다.

하위 호환성 요구 사항#

고객 대면 서비스를 유지할 때, 메인테이너는 지원되는 GitLab 버전 전반에 걸쳐 하위 호환성을 보장해야 합니다. GitLab 지원 성명서 및 Python 배포 가이드라인을 참조하세요. 변경 사항을 병합하기 전에 다른 GitLab 릴리즈를 사용하는 사용자에게 혼란을 주지 않도록 지원되는 모든 버전과의 호환성이 유지되는지 확인하세요.

Python 머지 리퀘스트 가이드라인

GitLab v19.1
원문 보기
요약

GitLab 표준 코드 리뷰 가이드라인은 Python 프로젝트에도 동일하게 적용됩니다. GitLab에서 Python 코드 리뷰 프로세스를 설정하는 데는 두 가지 주요 방법이 있습니다: 대규모 프로젝트: 대형 Python 프로젝트는 일반적으로 reviewer-roulette를 통해 자체 전담 리뷰어 풀을 보유합니다.

GitLab 표준 코드 리뷰 가이드라인은 Python 프로젝트에도 동일하게 적용됩니다.

Python 코드 리뷰 프로세스 설정 방법#

GitLab에서 Python 코드 리뷰 프로세스를 설정하는 데는 두 가지 주요 방법이 있습니다:

  • 대규모 프로젝트: 대형 Python 프로젝트는 일반적으로 reviewer-roulette를 통해 자체 전담 리뷰어 풀을 보유합니다. 설정 방법은 Reviewer Roulette 설정을 참조하세요.

  • 소규모 프로젝트: 기여자가 적은 프로젝트의 경우, GitLab 전반에 걸친 Python 리뷰어 공유 풀을 유지합니다.

Reviewer Roulette 설정#

이 섹션에서는 프로젝트를 reviewer roulette 및 기타 리소스와 통합하여 프로젝트 기여자와 Python 전문가를 코드 리뷰에 연결하는 방법을 설명합니다.

대규모 및 소규모 프로젝트 모두에서 Reviewer Roulette는 리뷰어 배정 프로세스를 자동화할 수 있습니다. 설정 방법:

그런 다음, 프로젝트 규모에 따라:

  • 기여자가 충분한 대규모 프로젝트의 경우:

자격을 갖춘 팀 멤버는 team_members 또는 team_database의 개인 항목에 있는 projects 필드에 Python 프로젝트를 추가하고, 리뷰어 또는 메인테이너와 같은 적절한 권한을 지정해야 합니다.

  • 프로젝트에 개별 roulette 구성을 추가합니다.

  • 소규모 프로젝트(예: 기여자가 10명 미만)의 경우:

프로젝트에 공유 풀 구성을 추가하여 회사 전체의 Python 전문가 풀을 활용합니다.

  • 필요한 경우 기여자 또는 비도메인 리뷰어가 도메인 전문 지식을 위해 팀 Slack 채널에서 도움을 요청하도록 권장할 수 있습니다.

머지 리퀘스트가 생성되면, Review Roulette가 구성에 따라 자격을 갖춘 리뷰어를 무작위로 선택합니다.

추가 권장 사항#

자세한 내용은 reviewer roulette를 참조하세요.

도움 요청#

기여자에게 Python 관련 리뷰에 대한 질문이 있거나 추가적인 도움이 필요한 경우, 지원을 위해 GitLab #python 또는 #python_maintainers Slack 채널로 안내하세요.

Python 메인테이너가 되는 방법#

대규모 프로젝트에는 자체 리뷰어 및 메인테이너 풀이 있습니다. 소규모 또는 신규 프로젝트는 GitLab의 기존 Python 전문가의 도움을 활용할 수 있습니다.

GitLab Python 전문가#

GitLab Python 전문가는 다양한 프로젝트에서 코드 품질 향상에 기여하는 Python 전문 지식을 보유한 전문가입니다. 전문가가 되려면:

  • team 파일의 projects 아래에 python: maintainer 역량을 추가하는 머지 리퀘스트를 생성합니다.

  • 이 템플릿을 사용하고 설명된 프로세스를 따릅니다.

머지 리퀘스트가 병합되면 Python 메인테이너 그룹에 추가됩니다.

특정 프로젝트의 리뷰어 및 메인테이너#

각 프로젝트는 자체 리뷰 프로세스를 수립할 수 있습니다. 자세한 내용은 메인테이너십 가이드라인을 검토하거나 현재 메인테이너에게 문의하세요.

메인테이너 책임#

코드 리뷰 외에도, 메인테이너는 아키텍처 결정을 안내하고 GitLab.com에서 도입된 관련 엔지니어링 사례를 모니터링하고 Python 프로젝트에 적용할 책임이 있습니다. 이를 통해 Python 프로젝트가 회사 표준과 일관성을 유지하고 부합하도록 보장합니다. 일관성을 유지하면 GitLab.com과 Python 프로젝트 간의 전환이 단순화되고 컨텍스트 전환 오버헤드가 줄어듭니다.

메인테이너의 기술적 전제 조건:

  • 특정 프로젝트에서 사용되는 Python 프레임워크에 대한 강력한 경험. 일반적으로 사용되는 프레임워크에는 FastAPI 및 Pydantic 등이 있습니다.

  • 고급 테스트 전략(예: 모킹, 통합 테스트, 테스트 주도 개발)을 포함하여 pytest와 같은 Python 테스트 프레임워크에 대한 숙련도.

  • 하위 호환성 고려 사항에 대한 이해(Work item).

코드 리뷰 목표:

  • 변경 사항이 스타일 가이드(Work item) 및 프로젝트의 기존 패턴을 준수하는지 확인합니다.

  • 해당하는 경우, 머지 리퀘스트에서 도입된 변경 사항에 대해 테스트 커버리지가 추가되었는지 확인합니다.

  • 성능 영향 검토.

  • 보안 취약점 확인.

  • 기존 시스템에 대한 코드 변경 영향 평가.

  • 머지 리퀘스트에 올바른 MR 유형 라벨이 있고 현재 마일스톤에 할당되어 있는지 확인합니다.

추가 책임:

  • 정확하고 완전한 문서 유지.

  • 필요에 따라 패키지 의존성 모니터링 및 업데이트.

  • 다른 엔지니어에게 Python 모범 사례 멘토링.

  • 새로운 도구 및 라이브러리 평가 및 제안.

  • 성능 모니터링 및 최적화 제안.

  • 보안 표준 유지 보장.

  • GitLab.com에 도입된 관련 엔지니어링 사례를 정기적으로 모니터링하고 적용하여 프로젝트가 GitLab 표준과 일관성을 유지하고 부합하도록 보장.

  • 명확한 코드 리뷰 프로세스 수립 및 시행.

코드 리뷰 모범 사례#

코드를 작성하고 리뷰할 때 스타일 가이드를 따르세요. 코드 작성자와 리뷰어는 다음 영역에 주의를 기울이도록 권장합니다.

리뷰 집중 영역#

GitLab에서 Python 코드를 리뷰할 때 다음 영역을 고려하세요:

1. 코드 스타일#

  • 코드가 합의된 Python 포맷팅 표준을 따르는지 확인합니다(파이프라인에서 적용됨).

  • 명명 규칙이 명확하고 설명적입니다.

  • 모든 공개 함수 및 클래스에 docstring이 사용됩니다.

2. 코드 품질#

  • 함수가 집중적이고, 과도하게 복잡하지 않으며, 테스트 가능합니다.

  • 과도한 주석 없이 코드가 읽기 쉽습니다.

  • 미사용 코드나 주석 처리된 코드가 없습니다.

3. 테스트#

  • 새 코드에 대한 테스트 커버리지가 충분합니다.

  • 테스트가 test_{file_being_tested}.py 명명 규칙을 따릅니다.

  • 외부 의존성에 대해 모킹이 적절하게 사용됩니다.

4. 문서화#

  • 함수와 클래스에 명확한 docstring이 있습니다.

  • 복잡한 로직에는 설명 주석이 있습니다.

  • 기능 추가 시 문서가 업데이트됩니다.

5. 보안#

  • 코드가 GitLab 보안 가이드라인을 따릅니다.

  • 입력값이 올바르게 검증됩니다.

  • 오류 처리가 적절합니다.

하위 호환성 요구 사항#

고객 대면 서비스를 유지할 때, 메인테이너는 지원되는 GitLab 버전 전반에 걸쳐 하위 호환성을 보장해야 합니다. GitLab 지원 성명서 및 Python 배포 가이드라인을 참조하세요. 변경 사항을 병합하기 전에 다른 GitLab 릴리즈를 사용하는 사용자에게 혼란을 주지 않도록 지원되는 모든 버전과의 호환성이 유지되는지 확인하세요.