GitHub Copilot 코드 검토에 대한 코딩 지침 정보

코딩 지침 정보

자연어로 작성된 사용자 지정 코딩 지침으로 Copilot 코드 검토를 사용자 지정할 수 있습니다. Copilot 코드 검토에 대한 자세한 내용은 Copilot 코드 검토 정보을(를) 참조하세요.

코딩 지침을 통해 Copilot은 조직의 특정 코딩 스타일 및 모범 사례에 따라 피드백을 제공할 수 있습니다.

Copilot 코드 검토는 대규모 언어 모델을 통해 구동되므로 Linter 또는 정적 분석 도구에서 다루지 않는 코딩 지침을 적용하는 데 도움이 될 수 있습니다.

코딩 지침은 리포지토리 수준에서 구성됩니다. 리포지토리당 최대 6개의 코딩 지침을 만들고 사용하도록 설정할 수 있습니다. GitHub Copilot 코드 검토에 대한 코딩 지침 구성을(를) 참조하세요.

Copilot에서 검토를 요청하면 리포지토리의 사용 가능한 코딩 지침을 자동으로 사용하여 코드를 검토합니다.

코딩 지침에 따라 생성된 메모에는 해당 원본을 강조 표시하는 메시지가 포함됩니다.

코딩 지침에 대한 해야 할 일과 하지 말아야 할 일

• ** 간단하고 명확하며 간결한 언어를 사용하여 코딩 지침을 설명합니다**.
• ** Copilot가 무엇을 찾아야 하는지, 즉 코드에서 보고 싶거나 보고 싶지 않은 것에 대해 가능한 한 구체적으로 설명합니다**.
• 아래의 코딩 지침 예제를 참고하여 영감을 얻으세요.
• 코딩 지침을 사용하여 Linter 또는 정적 분석 도구에서 다룰 수 있는 스타일 지침을 적용하지 마세요.
• 모호하거나 다른 방식으로 해석될 수 있는 단어를 사용하지 마세요.
• 여러 아이디어를 단일 코딩 지침에 맞추지 마세요.

코딩 지침 예제

예제 1: 매직 넘버 사용 방지

제목: Avoid using magic numbers

설명: Don't use magic numbers in code. Numbers should be defined as constants or variables with meaningful names.

경로 패턴:**/*.py

예제 2: SQL 쿼리에서 SELECT *을(를) 사용하지 않음

제목: Don't use `SELECT *` in SQL queries

설명: Don't use `SELECT *` in SQL queries. Always specify the columns you want to select. `COUNT(*)` is allowed.

경로 패턴: 없음(SQL 쿼리가 코드에 포함될 수 있으므로 모든 파일 형식에 적용됨).

예제 3: HTTP 요청에 fetch 사용

제목: Use `fetch` for HTTP requests

설명: Use `fetch` for HTTP requests, not `axios` or `superagent` or other libraries.

경로 패턴:**/*.ts, **/*.js, **/*.jsx **/*.tsx

예제 4: 항상 현재 환경을 사용하여 메트릭 태그 지정

제목: Always tag metrics with the current environment

설명: Always include a `env` tag with the current environment when emitting metrics, for example, `env:prod` or `env:dev`.

경로 패턴:*/*.go, */*.java

추가 참고 자료

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