GitHub Copilot 사용하여 회사의 끌어오기 요청 가속화

기능을 이해하고, 개발자를 사용하도록 설정하고, Copilot 영향을 측정합니다.

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

GitHub Copilot Business or GitHub Copilot Enterprise

이 기사에서

이 가이드는 엔지니어링 시스템 개선을 위한 전략과 측정 항목을 추천하는 GitHub의 ESSP(엔지니어링 시스템 성공 플레이북)에서 영감을 받았습니다.

Copilot을 출시하려면 목표를 정의하고, 이에 따라 출시를 계획하고, 직원에게 목표를 명확하게 전달하는 것이 좋습니다. GitHub Copilot을 사용하여 회사의 엔지니어링 목표 달성을(를) 참조하세요.

1. 성공을 가로막는 장애 요인 식별

ESSP에서 권장하는 첫 번째 단계는 회사의 개선을 방해하는 장애물을 명확히 이해하는 것입니다. 현재 기준, 원하는 미래 상태, 진행을 방해하는 장벽을 이해하게 되면 발생하는 변화의 방향이 목표 지향적이고 효과적이라는 것을 확신할 수 있습니다.

팀이 진행하는 끌어오기 요청 병합이 긴 검토 주기로 인해 지연되는 경우가 많습니다. 이러한 지연은 종종 다음에서 비롯됩니다.

  • 이해하기 어려운 복잡한 코드 변경
  • 검토를 어렵게 만드는 일관성 없는 코드 서식
  • 변경 내용과 함께 제공되는 일반적인 컨텍스트 부족
  • 해결하는 데 오래 걸리거나 해결하기 어려운 검토를 초래하는 사회적 요인

검토자는 프로덕션 문제로 이어질 수 있는 작은 오류를 쉽게 놓칠 수도 있습니다.

이로 인해 개발 프로세스에서 병목 현상이 발생하며, 기능의 전반적인 전달이 느려지고 품질이 저하됩니다.

2. 옵션 평가

다음 단계에서는 1단계에서 확인된 장벽을 해결하기 위한 솔루션을 평가하고 합의해야 합니다. 이 가이드에서는 GitHub Copilot이 사용자가 인지하는 목표 달성에 어떠한 영향을 미칠 수 있는지 중점적으로 살펴보겠습니다. 새 도구를 성공적으로 출시하려면 문화권 및 프로세스를 변경해야 합니다.

파일럿 그룹을 사용하여 새로운 도구 및 프로세스의 평가판을 실행하여 피드백을 수집하고 성공을 측정합니다. 평가판 중에 사용할 학습 리소스 및 메트릭에 대해서는 3. 변경 사항 구현 및 주의할 메트릭 섹션을 참조하세요.

          <a href="https://github.com/enterprise/contact?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline">
          <span>영업팀에 문의하기</span><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-link-external" aria-label="link external icon" role="img"><path d="M3.75 2h3.5a.75.75 0 0 1 0 1.5h-3.5a.25.25 0 0 0-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-3.5a.75.75 0 0 1 1.5 0v3.5A1.75 1.75 0 0 1 12.25 14h-8.5A1.75 1.75 0 0 1 2 12.25v-8.5C2 2.784 2.784 2 3.75 2Zm6.854-1h4.146a.25.25 0 0 1 .25.25v4.146a.25.25 0 0 1-.427.177L13.03 4.03 9.28 7.78a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042l3.75-3.75-1.543-1.543A.25.25 0 0 1 10.604 1Z"></path></svg></a>

어떻게 Copilot가 도움이 될 수 있는지

          GitHub Copilot 는 끌어오기 요청 검토 프로세스를 가속화하고, 코드 품질을 향상하고, 공동 작업을 개선하여 궁극적으로 병합 시간을 단축하도록 설계된 기능 모음을 제공합니다.

팀은 역량을 활용하여 Copilot워크플로를 간소화하고 마찰을 줄이며 일관되고 고품질의 코드를 보장할 수 있습니다.

완전하고 유용한 PR 요약을 생성합니다.

          Copilot 는 명확하고 간결한 PR 요약을 자동으로 생성하여 개발자 시간을 절약하고 검토자가 PR의 목적과 변경 내용을 쉽게 이해할 수 있도록 할 수 있습니다. 이렇게 하면 오해의 가능성이 줄어들고 검토 프로세스가 빨라집니다.

검토 프로세스 중에 검토자를 지원합니다.

          GitHub Copilot 는 강력한 PR 검토 도우미로 사용할 수 있습니다.

* Copilot 는 검토자가 PR이 기여하는 내용을 더 빠르게 이해할 수 있도록 복잡한 코드 변경 내용을 설명하는 데 도움이 될 수 있습니다. * Copilot 는 리포지토리 전체의 컨텍스트 인식 제안 및 잠재적 코드 개선 사항을 끌어오기 요청 검토 인터페이스 GitHub내에서 직접 제공하여 검토자가 잠재적인 문제를 파악하고 건설적인 피드백을 보다 효율적으로 제공할 수 있도록 지원합니다. * Copilot 는 검토자가 명확하고 일관되며 효과적인 검토 주석을 작성하고 초안을 작성하는 데 도움이 될 수 있습니다.

조직 지침에 따른 검토

  •         Copilot 끌어오기 요청을 열기 전에 IDE의 코드 변경 내용을 검토하거나 끌어오기 요청에 검토자로 할당할 수 있습니다.
  • 규칙 집합을 사용하면 사용자 지정 기준에 따라 끌어오기 요청을 체계적으로 검토하도록 설정할 Copilot 수 있습니다.
  • 검토 Copilot 에 대한 사용자 지정 지침을 사용하면 조직 코딩 표준 및 모범 사례를 적용하여 잠재적 위반에 자동으로 플래그를 지정하고 수정 사항을 제안할 수 있습니다.

이러한 기능은 코드베이스 전체에서 일관성을 보장하고 개발 프로세스 초기에 오류를 잡아내어 수동 코드 검토의 필요성을 줄이고 개발자 및 검토자를 위한 시간을 절약하는 데 도움이 됩니다.

코드 수정 제안

끌어오기 요청 검토 주석 Copilot 에 따라 끌어오기 요청 작성자가 검토를 해결하기 위해 필요한 코드 변경 내용을 신속하게 구현하는 데 도움이 될 수 있습니다.

문화적 고려 사항

GitHub Copilot의 출시와 함께 목표 달성에 방해가 될 수 있는 사회적 및 문화적 요인을 해결하십시오.

다음 예시는 ESSP의 ‘안티 패턴’ 섹션에서 발췌한 내용입니다.

  • 팀은 릴리스하기 위해 너무 오래 대기하여 대량의 코드 배치를 한 번에 배포하게 될 수 있습니다. 이러한 현상은 빈번한 릴리스로 인한 불안정, CI/CD 파이프라인 완성도 부족 또는 엄격한 규정 준수 요구 사항 등에 대한 우려로 인해 발생할 수 있습니다.
  • 개발자는 **코드를 완벽하게 다듬거나 ** 불필요한 기능을 추가하는 데 너무 많은 시간을 쓸 수 있습니다. 이것은 완벽주의 문화 또는 우선 순위를 효과적으로 지정하지 못한 상황으로 인해 발생할 수 있습니다.
  • 개발자는 간단한 문제에 대해 지나치게 복잡한 솔루션을 구축할 수 있습니다. 불필요하게 미래를 대비하려는 욕구 또는 복잡성을 통해 가치를 추가해야 한다는 압력 때문에 이러한 상황이 발생할 수 있습니다.

3. 변경 내용 구현

장벽을 극복하기 위한 올바른 방법을 확인한 경우 식별한 솔루션의 크기를 조정합니다. 새 도구 또는 프로세스의 성공적인 롤아웃을 위해 롤아웃의 각 부분에 소유권을 할당하고, 목표에 대해 투명하게 전달하고, 효과적인 교육을 제공하고, 결과를 측정합니다.

이 섹션에서는 개발자를 위한 예시 시나리오와 모범 사례, 그리고 관련 리소스를 안내합니다. 이 섹션에서는 직원들이 목표와 일치하는 방식으로 Copilot을(를) 사용할 수 있도록 커뮤니케이션 및 교육 세션을 계획 할 수 있습니다.

  •         [유용한 끌어오기 요청 요약 만들기](#create-helpful-pull-request-summaries)

  •         [검토 도우미로 사용 Copilot](#use-copilot-as-a-review-assistant)

  •         [검토자로 추가 Copilot](#add-copilot-as-a-reviewer)

  •         [검토 주석 구현에 대한 도움말 보기](#get-help-implementing-review-comments)

  •         [개발자를 위한 모범 사례](#best-practices-for-developers)

  •         [리소스](#resources)

유용한 끌어오기 요청 요약 만들기

  1. 끌어오기 요청을 Copilot 만들 때 "설명 추가" 필드에서 아이콘을 클릭한 다음 요약을 클릭합니다.
  2.        Copilot 는 끌어오기 요청을 검토하고 서술 형식으로 작성된 변경 사항의 개요와 영향을 미치는 파일에 대한 변경 사항의 목록을 제공합니다.

  3.        Copilot의 설명에 만족하는지 확인하십시오.
  4. 검토자가 끌어오기 요청을 확인하게 되면 검토 의견을 남기기 위해 필요한 모든 컨텍스트를 파악하게 됩니다.

검토 도우미로 사용 Copilot

검토자로서 끌어오기 요청에 참여할 때 Copilot를 사용하여 검토 속도를 높일 수 있습니다.

  1.        Copilot 데 사용합니다****.

    * Copilot에게 파일 변경 내용을 요약해 달라고 요청하세요. 이는 특히 더 긴 파일 차이에 유용합니다. 파일의 오른쪽 위 모서리를 클릭하여 diff에서 특정 파일을 선택할 수 있습니다.

    끌어오기 요청 "변경된 파일" 탭의 스크린샷에서 "Copilot에게 이 차이에 대해 물어보기" 옵션이 빨간색으로 강조 표시되어 있습니다.

    • 특정 줄의 변경 내용을 보려면 더 잘 이해하려는 줄을 강조 표시하고 변경 내용을 설명해 달라고 요청 Copilot 합니다. 먼저 맨 위 줄 번호를 클릭하고 Shift 키를 누른 다음, 차이의 맨 아래 줄을 클릭하여 줄 집합을 강조 표시할 수 있습니다.

      끌어오기 요청의 "변경된 파일" 탭의 스크린샷입니다. 선택한 줄이 강조 표시되며, 드롭다운에서 "설명" 옵션이 표시됩니다.

  2.        Copilot
       **PR 검토를 위한 공동 작업을 진행하세요**와 함께. 대화에서 Copilot를 사용하기 전에 특정 파일의 차이점을 첨부하는 것을 잊지 마세요.

    * Copilot에게 요청하여 PR 변경에 대한 의견을 자체적으로 물어볼 수 있습니다Provide your judgement as a PR Reviewer, both for functional and non-functional aspects that these changes bring. 이 프롬프트가 Copilot 코드의 기능적 측면과 비기능적 측면을 모두 고려하도록 요청하는 방법을 확인합니다.

    • 자신의 PR 검토 의견에 대하여 Copilot에게 두 번째 의견을 요청하십시오: As my peer reviewer on this pull request, give me your feedback on my own review: YOUR-REVIEW-COMMENT. Do you think it's pertinent? Am I missing something?
  3.        Copilot 공동 작업하여 **검토 의견의 초안을 작성하고 수정합니다**.
    • 검토를 Copilot 계획한 후, 제공해야 하는 주석을 나열하도록 요청할 수 있습니다: Make a list of review comments to add to the PR and tell me exactly in which file diff and lines each comment should be added.
    • 또한 마음에 있는 리뷰 댓글의 첫 번째 초안을 만들거나 게시하기 전에 메모를 구체화하도록 요청할 Copilot 수도 있습니다 Help me draft review comments as discussed``Refine this review comment to make it clear, concise, and actionable.

검토자로 추가 Copilot

검토 시간을 줄이고 끌어오기 요청을 더 빠르게 병합하려면, 코드 검토를 체계적으로 사용하세요: 먼저 끌어오기 요청을 열기 전에 IDE에서 Copilot 코드를 검토하고, 그 다음 PR에서 GitHub 코드를 검토하세요.

코드 검토를 사용하면 Copilot 사용자 코드 검토의 필요성이 대체되지 않습니다. 그러나 위의 단계를 수행하면 사용자가 검토를 더 빨리 완료하는 데 도움이 될 수 있습니다.

  •         **개발자는** 끌어오기 요청을 열기 전에 코드 검토를 사용하여 Copilot 모든 변경 내용에 대한 검토를 요청해야 합니다.

  •         **관리자는** 보호된 분기를 대상으로 하는 모든 끌어오기 요청에 Copilot가 검토자로 자동 추가되도록 리포지토리 또는 조직 규칙을 설정해야 합니다.

  •         **팀 리더** 는 팀의 표준 스타일과 규칙을 캡처하고 검토에서 활용할 수 있도록 Copilot 조직에 대한 사용자 지정 지침으로 설정해야 합니다.
    • 코드 가독성을 높이는 최소한의 스타일 권장 사항을 사용자 지정 지침에 적용하세요. 그러면 끌어오기 요청 검토 프로세스 중에 도움이 됩니다.
    • 스타일 지정 문제로 인한 PR 검토 주석의 양을 줄이려면 리포지토리 및 조직 수준의 지침에 Copilot 동일한 권장 사항을 설정합니다. 이렇게 하면 생성된 코드가 Copilot 이러한 지침을 준수합니다.

검토 주석 구현에 대한 도움말 보기

끌어오기 요청 작성자는 Copilot의 도움으로 신속하게 수정을 구현하여 PR 리뷰 코멘트의 해결 속도를 높일 수 있습니다.

  •         Copilot 자체에서 남긴 검토 주석의 경우 제안된 수정 사항을 직접 커밋하거나 커밋하기 전에 Copilot 작업 영역에서 편집합니다.
  • 피어가 남긴 검토 주석의 경우 PR 검토 주석과 관련된 파일 차이로 이동하여 대화에 diff를 Copilot 채팅 첨부합니다. 그런 다음, 검토 주석을 복사하고 Suggest a fix for this review comment:와 같은 프롬프트에 붙여넣습니다.
  • VS Code를 사용하는 경우 에이전트 모드에서 검토 주석에서 필요한 변경 내용을 구현하도록 요청 GitHub Copilot 합니다.

개발자를 위한 모범 사례

개발자는 다음을 수행해야 합니다.

  • 푸시하기 전에 IDE에서 Copilot의 리뷰를 요청하여 문제를 조기에 발견하고 해결하세요.
  • PR 작성자가 문제를 이해하고 해결하는 데 도움이 되도록 고유한 PR 검토 주석을 계획하고 구체화하는 데 사용합니다 Copilot .
  • 대화에 Copilot를 포함하여 특정 코드 줄을 비롯한 관련 diff 컨텍스트를 연결합니다.

개발자는 다음을 수행해서는 안 됩니다.

  • 테스트하지 않고 Copilot의 제안을 적용합니다.
  • 리뷰에 Copilot 만 의존합니다.
  • 코드 가독성을 무시하지 마세요.

리소스

  •         [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-for-pull-requests/creating-a-pull-request-summary-with-github-copilot)

  •         [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review?tool=vscode#reviewing-changes)

  •         [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions)

  •         [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review)

  •         [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)

주목할 지표

새 도구의 평가판을 평가하고 전체 롤아웃이 일관된 개선을 제공하고 있는지 확인하려면 결과를 모니터링하고 필요한 경우 조정합니다. 품질, 속도 및 개발자 행복의 주요 영역과 이러한 영역이 함께 모여 비즈니스 결과에 기여하는 방법을 고려하는 것이 좋습니다.

다음은 특정 목표에 대한 Copilot의 영향을 평가하는 데 사용할 수 있는 몇 가지 지표입니다.

  •         **개발자 만족도**: 개발자 설문 조사를 사용하여 엔지니어링 도구에 대한 만족도를 측정합니다.

  •         **개발자당 병합된 끌어오기 요청**: `pull request` 웹후크를 사용하여, `action`이 `closed`이고 `merged` 개체 내의 `pull request` 속성이 `true`가 되도록 합니다.

  •         **풀 리퀘스트 리드 타임**: PR 생성과 머지 사이의 평균 시간을 측정하세요.

  •         **끌어오기 요청 결함 회피율**: 잘못 검토된 PR로 인한 배포 문제의 비율을 측정합니다.

  •         **Pull Request 리뷰 댓글 유형**: PR 리뷰 댓글을 다운로드하고, AI 기반 주제 분류를 사용하여 분류하며, 검토자가 설계, 확장성 및 전략에 대해 작성한 댓글을 추적합니다.