Skip to main content

리포지토리 백로그에서 코드 품질 결과 수정

리포지토리의 기본 브랜치에 있는 발견 사항에 대해 자동 수정을 생성하거나, 관련 없는 발견 사항을 무시합니다.

누가 이 기능을 사용할 수 있나요?

쓰기 권한이 있는 사용자

GitHub Team 또는 GitHub Enterprise Cloud

Code Quality이 처음이라면 리포지토리의 품질 점수를 검토하고 개선하는 방법을 단계별로 안내하는 리포지토리의 코드 품질 점수 올리기을 참조하세요.

기본 브랜치에서 Code Quality가 작동하는 방식

Code Quality는 기본 브랜치를 검사하고 리포지토리의 코드 품질 탭에 있는 " Security and quality" 페이지에 발견 사항을 보고합니다. 두 가지 유형의 분석을 실행합니다.

  1. ** 표준 결과 **: Code Quality는 CodeQL를 사용하여 기본 브랜치에 대해 결정적이고 규칙 기반의 검사를 수행합니다. 검사 결과는 규칙과 언어별로 그룹화되고, 심각도(Error, Warning, Note)로 레이블이 지정되며, 각 항목에는 제안된 자동 수정이 포함됩니다.

  2. ** AI 결과 **: Code Quality AI 기반 분석을 사용하여 모범 사례, 명명 규칙 또는 디자인 고려 사항과 같이 규칙 기반 분석에서 검색할 수 없는 문제를 포함하여 가장 최근에 기본 분기에 푸시된 파일의 품질 문제를 식별합니다.

참고

최근 변경된 파일용 "AI 결과" 페이지는 현재 공개 미리 보기 상태이며 변경될 수 있습니다.

해결에 대한 자세한 내용은 AI 결과을 참조하세요.

표준 발견 사항 해결

  1. 리포지토리의 Security and quality 탭으로 이동합니다.

  2. 코드 품질 을(를) 확장하려면 클릭하고, 그런 다음 표준 결과 을(를) 클릭합니다.

  3. 대시보드 필터를 사용하여 품질 점수에 영향을 줄 가능성이 가장 큰 결과에 초점을 맞춥니다. 예를 들어 "안정성"에 대한 모든 "오류" 수준 결과를 보려면 필터를 다음으로 설정합니다.

    is:open category:reliability severity:error

  4. 검색 결과는 규칙별로 그룹화됩니다. 규칙 이름을 클릭하여 해당 규칙에 대한 모든 결과를 자세히 볼 수 있습니다.

    "표준 결과" 보기의 규칙을 보여 주는 스크린샷 규칙 이름이 진한 주황색으로 강조 표시됩니다.

  5. 자세히 표시를 클릭한 다음 규칙의 설명, 권장되는 수정 사항, 코드 예제 및 참조를 검토합니다.

코드 품질 규칙의 결과를 보여 주는 스크린샷 "자세히 표시" 텍스트가 진한 주황색으로 강조 표시됩니다.

  1. 개별 찾기의 오른쪽에서 수정 생성을 클릭합니다.
  2. 제안된 변경 내용의 차이 검토 동의하면 끌어오기 요청 열기를 클릭합니다.
  3. "브랜치에 자동 수정 커밋" 대화 상자에서 "풀 리퀘스트 열기"를 선택한 다음 변경 사항 커밋을 클릭합니다.
  4. 자동 수정 풀 리퀘스트의 검토 준비가 완료되면 상태를 "Draft"에서 "Ready for review"로 변경하고, 병합하기 전에 CI 검사가 통과할 때까지 기다리세요.
  5. 또는 발견이 관련이 없거나 실행 가능하지 않은 경우 해제를 클릭합니다. 예를 들어 레거시 코드에서 더 이상 유지 관리되지 않는 결과를 해제하거나, 팀의 코딩 표준에 알려진 예외이거나, 실제 품질 위험을 초래하지 않는 가양성인 경우를 해제할 수 있습니다.

유지 관리 가능성 또는 안정성 점수를 높이려면 현재 해당 메트릭에 영향을 주는 가장 높은 심각도 수준에서 모든 결과를 해결해야 합니다. 메트릭 및 점수 참조을(를) 참조하세요.

코드 품질 점수가 업데이트되었는지 확인

자동 수정 풀 리퀘스트가 병합된 후에는 "표준 결과" 보기로 돌아가 다음을 확인하세요.

  • 발견 항목 수가 감소했습니다.
  • 해당 메트릭에 대한 현재 최소 심각도 수준에서 모든 결과를 해결한 경우 유지 관리 가능성 또는 안정성 점수가 향상되었습니다.

다음 단계