소개
GitHub Code Quality (공개 미리 보기)를 사용하면 끌어오기 요청 및 기본 분기에서 코드 품질 결과를 표시하여 코드를 안정적이고 유지 관리할 수 있습니다.
이 자습서에서는 기본 분기에서 코드 품질 찾기를 식별하고 수정하여 리포지토리의 코드 상태를 개선하는 방법을 알아봅니다.
필수 조건
- GitHub Code Quality 는 리포지토리에 대해 사용하도록 설정해야 하며 지원되는 언어의 코드가 있어야 합니다. GitHub Code Quality를 활성화합니다.을(를) 참조하세요.
- GitHub Code Quality을(를) 처음 활성화하는 경우, 활성화 후 몇 분 동안 기본 분기의 전체 CodeQL 스캔이 완료될 때까지 기다렸는지 확인하세요.
기본 브랜치에 대한 스캔 결과를 확인합니다.
리포지토리에서 Security and quality 탭으로 이동한 후, 왼쪽 사이드바에서 코드 품질 을 클릭하고, 표준 결과 를 클릭하여 리포지토리 대시보드를 엽니다.
여기에서 다음을 확인할 수 있습니다.
-
코드베이스의 안정성 및 유지 관리에 대한 등급으로 코드 상태를 한눈에 파악할 수 있습니다.
-
규칙 및 언어별로 그룹화된, 기본 분기에서 CodeQL에 의해 감지된 모든 품질 문제에 대한 결과 목록입니다.
영향력이 높은 발견을 식별하다
**대시보드 필터를** 사용하여 높은 심각도 수준 찾기("오류" 또는 "경고")를 식별합니다.
이러한 문제를 해결하면 리포지토리의 등급에 가장 큰 영향을 미칩니다.
발견사항의 세부 정보 검사
규칙 이름 자체를 클릭하여 해당 규칙의 영향을 받는 파일 및 코드 줄에 대한 자세한 보기를 확인합니다.
자세한 보기에 있으면 [자세히 보기]를 클릭하여 컨텍스트를 수집하고 결과를 이해합니다.
코파일럿 자동 수정 생성
강조 표시된 찾기의 오른쪽에서 수정 생성을 클릭합니다****.
제안된 수정 사항을 검토한 다음 끌어오기 요청 열기를 클릭합니다.
수정 사항 병합
초안 끌어오기 요청을 신중하게 검토합니다. 제안된 변경 내용에 만족하고 모든 검사 및 테스트가 통과되는 경우 계속 진행하여 끌어오기 요청을 병합합니다.
메트릭 변경 관찰
대시보드로 Code Quality 돌아갑니다 ( Security and quality 탭, 다음 코드 품질, 그리고 표준 결과).
다음 검색이 완료 Code Quality 되기까지 몇 분 정도 기다립니다. 기본 분기로 푸시할 때마다 검색이 자동으로 다시 실행됩니다.
대시보드 맨 위에 있는 메트릭의 변경 내용을 관찰합니다.
-
"안정성" 또는 "유지 관리 기능"에 대한 결과 수가 감소해야 합니다.
-
등급이 "안정성" 또는 "유지 관리 가능성"에 대한 것으로, 여러 중요한 문제점을 해결한 경우 향상되었을 수 있습니다.
등급 계산 방법에 대한 자세한 내용은 메트릭 및 등급 참조을 참조하세요.
결론
여러분은 Code Quality와 코파일럿 자동 수정을 사용하여 리포지토리의 코드 상태를 성공적으로 개선했습니다.
정상 코드는 코드 품질 문제를 더 쉽게 이해하고, 유지 관리하고, 확장하고, 수정하면 코드베이스를 보다 안정적이고 규정을 준수하며 향후 개발을 가속화할 수 있습니다.
다음 단계
- 코드 품질 문제가 기본 브랜치에 도달하지 못하도록 끌어오기 요청에서 GitHub Code Quality 작동 방식을 알아봅니다. 끌어오기 요청을 병합하기 전에 코드 품질 결과 수정을(를) 참조하세요.
- GitHub Code Quality에 대해 커뮤니티 토론에서 피드백을 제공합니다.