SebastienDegodez/copilot-instructions

Welcome to the Copilot Instructions repository!

이 프로젝트는 특히 GitHub Copilot 및 유사한 도구를 활용한 AI 보조 개발 (AI-assisted development)을 안내하기 위한 일련의 모범 사례 (best practices), 코딩 규칙 (coding rules), 그리고 프롬프트 지침 (prompt instructions)을 제공합니다.

• 명확한 코딩 표준 (coding standards) 및 아키텍처 규칙 (architectural rules)을 정의합니다 (예: 도메인 주도 설계 (Domain-Driven Design), 테스트 전략 (testing strategies)).
• 일관되고 고품질인 코드 생성 (code generation)을 위한 프롬프트 (prompt) 및 지침 (instruction) 파일을 제공합니다.
• 팀과 AI 도구가 유지보수 가능하고, 견고하며, 표현력이 풍부한 코드를 위해 동일한 가이드라인을 따르도록 돕습니다.

Clone the repository

터미널을 열고 다음을 실행하세요: git clone https://github.com/your-username/copilot-instructions.git

Explore the repository

• 코딩 규칙 및 모범 사례를 확인하려면 instructions/를 확인하세요.
• 특화된 기능 및 번들 리소스를 검토하려면 skills/를 확인하세요.
• 커스텀 AI 페르소나 (AI personas)를 살펴보려면 agents/를 확인하세요.
• 큐레이션된 컬렉션을 설치하려면 plugins/에서 플러그인을 설치하세요.
• 대화형 문서를 방문하려면 website/를 방문하세요.

Apply the rules

• 프로젝트에서 문서화된 표준을 따르세요.

• 일관된 코드 생성을 위해 Copilot 또는 기타 AI 도구를 구성하는 데 이 파일들을 사용하세요.

• 🏛️ 도메인 주도 설계 (Domain-Driven Design, DDD) 가이드라인 (instructions 참조)

• 📐 비즈니스 규칙을 위한 명세 패턴 (Specification pattern) (instructions 참조)

• 🧪 단위 및 통합 테스트 (Unit & Integration testing) 모범 사례 (instructions 참조)

• 🗂️ 명령/조회 (Command/Query, CQRS) 모범 사례 (command instructions 참조)

• 📝 영어 전용 문서화 정책 (English-only documentation policy)

• 🤖 Copilot 및 AI 프롬프트 지침 (prompt instructions)

• 🔄 C#을 위한 TDD 우선 워크플로우 (TDD-first workflow) (copilot-instructions.md 참조)

• ❓ 후속 질문 강제 (Follow-up Question Enforcement) (instructions 참조)

AI는 코드 생성 전에 반드시 명확히 하는 질문을 던지고 확신을 보여야 합니다.

• 🌐 Microsoft MCP 서버 통합: 이 저장소는 Microsoft 문서에 대한 실시간 액세스를 제공하고 AI 생성 응답을 향상시키기 위해 공식 Microsoft MCP 서버를 통합합니다 (자세히 알아보기).
• 🐶 .NET 프로젝트를 위한 Husky 설정 프롬프트 (prompts/huskydotnet.prompt.md 참조)

) - 🤡 API Mocking 및 계약 테스트 (contract testing)를 위한 Microcks 메타데이터 지침:

이 저장소는 GitHub Copilot의 기능을 향상시키기 위해 지침 (instructions), 기술 (skills), 에이전트 (agents) 및 플러그인 (plugins)을 구성하는 awesome-copilot 구조와 관례를 따릅니다.

지침 (Instructions): 특정 파일 패턴에 적용되는 코딩 표준 및 모범 사례 (best practices)
기술 (Skills): 관련 리소스와 함께 SKILL.md 파일을 묶은 독립적인 기능
에이전트 (Agents): 특화된 워크플로우를 위한 맞춤형 AI 페르소나 (personas)
플러그인 (Plugins): 관련 기술과 에이전트를 묶은 설치 가능한 패키지

├── instructions/ # 코딩 표준 및 모범 사례 (.instructions.md)
├── agents/ # 맞춤형 AI 에이전트 (.agent.md)
├── skills/ # 리소스가 포함된 독립적인 기능
...

DDD, 클린 아키텍처 (Clean Architecture), CQRS 및 테스트 모범 사례를 포함하는 C# 개발자를 위한 종합 플러그인입니다.

위치: plugins/csharp-clean-architecture-development/

기술 (Skills): application-layer-testing, clean-architecture-dotnet
설치: 자세한 내용은 플러그인 README를 참조하세요

더 많은 사용 가능한 플러그인은 plugins/를 확인하세요.

**컬렉션 (collection)**은 관련 지침, 프롬프트 (prompts) 및 채팅 모드 (chatmodes)를 재사용 가능한 패키지로 그룹화하는 YAML 파일 (collections/에 위치)입니다. 컬렉션은 AI 에이전트를 위한 "프리미티브 (primitives)"를 제공하기 위해 **APM (Agent Package Manager)**에 의해 소비되도록 설계되었습니다.

APM을 사용하면 프로젝트에서 이러한 컬렉션을 쉽게 설치하고 관리할 수 있습니다. 지침 파일을 수동으로 복사하는 대신 APM을 사용하여 다음을 수행할 수 있습니다:

• 특정 기술 스택에 맞게 큐레이션된 지침 세트 설치
• 여러 프로젝트에 걸쳐 AI 프리미티브를 최신 상태로 유지
• 팀과 모범 사례 공유

**채팅 모드 (chatmode)**는 Copilot 또는 다른 AI 어시스턴트가 특정 컨텍스트나 워크플로우에서 어떻게 동작해야 하는지를 정의하는 설정 파일 (chatmodes/에 위치)입니다. 예를 들어, architect

chatmode는 AI가 숙련된 아키텍트(Architect) 및 기술 리드(Technical Lead)로서 동작하게 하며, 계획 수립, 문서화, 그리고 Markdown 전용 출력에 집중하도록 만듭니다. Chatmode는 세션 또는 프로젝트 진행 동안 AI의 어조(Tone), 우선순위, 제약 사항을 설정할 수 있습니다.

**메타-챗모드 (meta-chatmode)**는 다른 chatmode 파일들을 어떻게 작성하고, 구조화하며, 검증할지를 정의하는 특별한 chatmode 파일(예: meta-chatmode.instructions.md)입니다. Meta-chatmode는 모든 chatmode가 저장소 전체에서 일관된 형식과 모범 사례(Best practices)를 따르도록 보장합니다. 이들은 chatmode 파일에 필요한 파일 구조, 명명 규칙(Naming conventions), 기대 동작 및 검증 체크리스트를 지정합니다.

**인스트럭션 (instruction)**은 프로젝트를 위한 코딩 규칙, 아키텍처 표준 및 모범 사례를 정의하는 Markdown 파일(instructions/에 위치)입니다. Instruction은 항상 활성화되어 있으며, 저장소 내에서 생성되는 모든 코드와 문서에 대해 반드시 준수되어야 합니다. 이는 일관성, 유지보수성, 그리고 프로젝트의 기술적 비전(예: DDD, Specification pattern, 테스트, 커밋 컨벤션)과의 정렬을 보장합니다.

**메타-인스트럭션 (meta-instruction)**은 다른 instruction 파일들을 어떻게 작성하고, 구조화하며, 검증할지를 정의하는 특별한 instruction 파일(예: meta-instructions.instructions.md)입니다. Meta-instructions는 모든 instruction이 저장소 전체에서 일관된 형식과 모범 사례를 따르도록 보장합니다.

**프롬프트 (prompt)**는 Copilot 또는 다른 AI 도구가 특정 스타일로 또는 특정 사용 사례를 위해 코드나 문서를 생성할 수 있도록 돕는 템플릿 또는 가이드 파일(prompts/에 위치)입니다. Prompt는 재사용이 가능하며, TDD(Test-Driven Development) 강제, API 문서 작성, 또는 테스트 케이스 생성과 같은 특정 작업에 대해 AI를 특정 방향으로 유도할 수 있습니다.

**스킬 (skill)**은 전문 지식, 워크플로우 및 도구를 통해 GitHub Copilot의 기능을 확장하는 모듈식의 독립적인 패키지(skills/에 위치)입니다. Skill은 특정 도메인이나 작업을 위한 "온보딩 가이드" 역할을 수행하며, Copilot을 전문화된 에이전트(Agent)로 변모시킵니다.

clean-architecture-dotnet: DDD (Domain-Driven Design) 및 CQRS (Command Query Responsibility Segregation, MediatR 미사용)를 적용한 Clean Architecture(클린 아키텍처) 완전 가이드. 프로젝트 초기화 스크립트 및 ArchUnit 검증 포함
application-layer-testing: Sociable testing (사회적 테스트) 전략을 사용한 Application layer(애플리케이션 계층) 핸들러 테스트 (실제 Domain(도메인) 객체 사용, Infrastructure(인프라스트럭처)는 모킹)
skill-creator: GitHub Copilot skill(스킬) 생성 및 관리

기여(Contributions)를 환영합니다!

규칙을 개선하거나, 새로운 관행을 추가하거나, 문서를 업데이트하려면 자유롭게 이슈(Issue)를 생성하거나 풀 리퀘스트(Pull Request)를 제출해 주세요.

⚡

곧 출시 예정:

• API 엔드포인트, Feature slicing(기능 슬라이싱) 및 Observability(관측성)를 위한 규칙과 모범 사례(Best practices).
• microcks-aspire-dotnet-demo 리포지토리는 이러한 규칙과 관행을 위한 공식 데모 및 테스트베드(Testbed)입니다.

즐거운 코딩 되세요! 💡✨

질문이 있다면 주저하지 말고 이슈를 생성하거나 문의해 주세요.