GitHub Copilot 코드 검토에 대한 코딩 지침 구성

사용자 지정 코딩 지침을 사용하여 Copilot 코드 검토을 사용자 지정하는 방법을 알아봅니다.

이 문서의 내용

참고 항목

사용자 지정 코딩 가이드라인 기능은 Copilot Enterprise 플랜에서만 제공되며, 현재는 일부 고객에게만 제공됩니다.

이 기능은 더 이상 사용되지 않으며, 대신 Copilot 코드 검토를 사용자 지정하기 위한 Copilot 사용자 지정 지침을 사용할 예정입니다. GitHub Copilot에 대한 리포지토리 사용자 지정 지침 추가을(를) 참조하세요.

코딩 지침 정보

Copilot에 자연어로 작성된 코딩 지침 집합을 제공하여 조직의 코딩 스타일 및 모범 사례에 맞는 방식으로 코드를 검토하는 데 도움을 줄 수 있습니다. 코딩 지침의 예를 비롯한 자세한 내용은 GitHub Copilot 코드 검토에 대한 코딩 지침 정보을(를) 참조하세요.

코딩 지침 만들기

  1. GitHub에서 리포지토리의 기본 페이지로 이동합니다.

  2. 리포지토리 이름 아래에서 설정을 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.

    탭을 보여 주는 리포지토리 헤더의 스크린샷. "설정" 탭이 진한 주황색 윤곽선으로 강조 표시됩니다.

  3. 사이드바의 "Code & automation" 섹션에서 Copilot 을 클릭한 다음, Code review를 클릭합니다.

  4. 지침 만들기를 클릭합니다.

  5. "이름"에서 코딩 지침에 이름을 지정합니다.

  6. "설명"에서 최대 600자까지 코딩 지침에 대한 설명을 제공합니다. Copilot에서 코딩 스타일을 이해하고 설명을 남길 시기를 결정하는 데 사용됩니다.

    설명을 작성하는 방법은 Copilot에서 생성할 댓글 품질에 큰 영향을 줍니다. 효과적인 코딩 지침 작성에 대한 도움말은 GitHub Copilot 코드 검토에 대한 코딩 지침 정보을(를) 참조하세요.

  7. 필요에 따라 파일 경로 추가를 클릭하고 경로 패턴을 추가하여 코딩 지침을 특정 파일 형식 또는 경로로 제한합니다.

    fnmatch 구문을 사용하여 대상 경로를 정의할 수 있으며 *을(를) 모든 문자열과 일치하는 와일드카드로 지정할 수 있습니다.

    GitHub에서 File::FNM_PATHNAME 플래그를 File.fnmatch 구문에 사용하므로 *와일드카드는 디렉터리 구분 기호(/)와 일치하지 않습니다. 예를 들어 qa/*은 qa/로 시작하고 단일 슬래시를 포함하는 모든 분기와 일치하지만 qa/foo/bar과 일치하지 않습니다.. 다음과 같이 qa과 일치하는 qa/**/*는 슬래시를 원하는 대로, 예를 들어 qa/foo/bar/foobar/hello-world 포함할 수 있습니다. qa 문자열을 qa**/**/*와 확장하여 규칙을 더 포괄적으로 만들 수도 있습니다.

    구문 옵션에 대한 자세한 내용은 fnmatch 문서를 참조하세요.

  8. 코딩 지침을 테스트하여 예상대로 작동하는지 확인합니다.

    1. 샘플 추가를 클릭합니다.
    2. 사용자 고유의 샘플을 추가하거나 Generate code sample을 눌러 제목 및 설명에 따라 코드 샘플을 자동으로 생성합니다.
    3. 저장을 클릭하여 코드 샘플을 저장합니다.
    4. Run을 눌러 샘플에 대한 코딩 지침을 테스트합니다.

  9. 코딩 지침을 저장하고 지침 저장을 클릭하여 설정합니다.