본문으로 건너뛰기

Awesome Instructions

특정 파일 패턴이나 전체 프로젝트에 적용되는 포괄적인 코딩 표준 및 모범 사례입니다.

개요​

Awesome Instructions는 GitHub Copilot이 코드를 생성할 때 따라야 할 규칙과 가이드라인을 제공합니다. 이러한 지침은 파일 패턴에 따라 자동으로 적용되어 일관된 코드 품질을 보장합니다.

작동 방식​

Instructions는 .instructions.md 파일로 저장되며, 프론트매터에 정의된 파일 패턴과 일치하는 파일에 자동으로 적용됩니다.

예제​

---
description: 'TypeScript 코드 생성 지침'
applyTo: '**/*.ts'
---

# TypeScript 코딩 표준

## 타입 안정성

- 모든 함수 매개변수와 반환값에 명시적 타입 지정
- `any` 타입 사용 금지
- 엄격한 null 체크 활성화

주요 기능​

🎯 자동 적용​

파일을 열거나 편집할 때 관련 지침이 자동으로 활성화됩니다.

📐 파일 패턴 매칭​

glob 패턴을 사용하여 특정 파일 유형에 지침을 적용합니다:

  • **/*.py - 모든 Python 파일
  • src/**/*.tsx - src 디렉토리의 모든 TSX 파일
  • **/test/**/*.js - 테스트 디렉토리의 모든 JavaScript 파일

🔄 계층 구조​

여러 지침이 동시에 적용될 수 있으며, 더 구체적인 지침이 우선합니다.

일반적인 사용 사례​

1. 코딩 표준​

프로젝트나 조직의 코딩 표준을 정의:

  • 명명 규칙
  • 코드 구조
  • 주석 스타일
  • 포맷팅 규칙

2. 프레임워크 가이드라인​

특정 프레임워크나 라이브러리 사용 시 모범 사례:

  • React 컴포넌트 패턴
  • Django 모델 설계
  • Express.js 라우팅
  • FastAPI 엔드포인트 구조

3. 보안 정책​

보안 관련 규칙과 금지 사항:

  • 입력 검증
  • 인증 및 권한 부여
  • 민감한 데이터 처리
  • SQL 인젝션 방지

4. 성능 최적화​

성능 관련 지침:

  • 캐싱 전략
  • 데이터베이스 쿼리 최적화
  • 메모리 관리
  • 비동기 처리

Instructions 작성 모범 사례​

✅ 해야 할 것​

  • 구체적으로: 명확하고 실행 가능한 지침 제공
  • 예제 포함: 좋은 예와 나쁜 예를 보여주세요
  • 우선순위 지정: 중요한 규칙을 강조하세요
  • 업데이트 유지: 정기적으로 검토하고 업데이트하세요

❌ 하지 말아야 할 것​

  • 모호함: 애매하거나 해석이 다양한 지침 피하기
  • 과도함: 너무 많은 규칙은 혼란을 야기
  • 상충: 서로 모순되는 지침 피하기
  • 과거 기술: 오래된 패턴이나 폐기된 방법 권장 피하기

인기 있는 Instructions​

Python​

  • PEP 8 스타일 가이드
  • 타입 힌트 사용
  • Docstring 규칙
  • 테스트 작성 방법

JavaScript/TypeScript​

  • ESLint 규칙
  • 타입 안정성
  • React 모범 사례
  • 비동기 패턴

Java/.NET​

  • 명명 규칙
  • SOLID 원칙
  • 디자인 패턴
  • 예외 처리

Go​

  • 효과적인 Go 스타일
  • 에러 처리
  • 동시성 패턴
  • 테스트 작성

더 알아보기​

전체 지침 목록과 상세 문서는 Awesome Instructions 문서를 참조하세요.

기여하기​

새로운 지침을 추가하고 싶으신가요? 기여 가이드를 확인하세요.