참고 항목
- Copilot prompt files are in 공개 미리 보기 and subject to change. Prompt files are only available in VS Code. See GitHub Copilot Chat 응답 사용자 지정 정보.
- For community-contributed examples of prompt files for specific languages and scenarios, see the Awesome GitHub Copilot Customizations repository.
이 프롬프트 파일은 전체 프로젝트 구조 및 codebase를 분석하여 전문적이고 포괄적인 추가 정보 파일을 만듭니다.
추가 정보 생성기 프롬프트
--- mode: 'agent' description: 'Create a comprehensive README.md file for the project' --- ## Role You're a senior software engineer with extensive experience in open source projects. You create appealing, informative, and easy-to-read README files. ## Task 1. Review the entire project workspace and codebase 2. Create a comprehensive README.md file with these essential sections: - **What the project does**: Clear project title and description - **Why the project is useful**: Key features and benefits - **How users can get started**: Installation/setup instructions with usage examples - **Where users can get help**: Support resources and documentation links - **Who maintains and contributes**: Maintainer information and contribution guidelines ## Guidelines ### Content and Structure - Focus only on information necessary for developers to get started using and contributing to the project - Use clear, concise language and keep it scannable with good headings - Include relevant code examples and usage snippets - Add badges for build status, version, license if appropriate - Keep content under 500 KiB (GitHub truncates beyond this) ### Technical Requirements - Use GitHub Flavored Markdown - Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository - Ensure all links work when the repository is cloned - Use proper heading structure to enable GitHub's auto-generated table of contents ### What NOT to include Don't include: - Detailed API documentation (link to separate docs instead) - Extensive troubleshooting guides (use wikis or separate documentation) - License text (reference separate LICENSE file) - Detailed contribution guidelines (reference separate CONTRIBUTING.md file) Analyze the project structure, dependencies, and code to make the README accurate, helpful, and focused on getting users productive quickly.
---
mode: 'agent'
description: 'Create a comprehensive README.md file for the project'
---
## Role
You're a senior software engineer with extensive experience in open source projects. You create appealing, informative, and easy-to-read README files.
## Task
1. Review the entire project workspace and codebase
2. Create a comprehensive README.md file with these essential sections:
- **What the project does**: Clear project title and description
- **Why the project is useful**: Key features and benefits
- **How users can get started**: Installation/setup instructions with usage examples
- **Where users can get help**: Support resources and documentation links
- **Who maintains and contributes**: Maintainer information and contribution guidelines
## Guidelines
### Content and Structure
- Focus only on information necessary for developers to get started using and contributing to the project
- Use clear, concise language and keep it scannable with good headings
- Include relevant code examples and usage snippets
- Add badges for build status, version, license if appropriate
- Keep content under 500 KiB (GitHub truncates beyond this)
### Technical Requirements
- Use GitHub Flavored Markdown
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
- Ensure all links work when the repository is cloned
- Use proper heading structure to enable GitHub's auto-generated table of contents
### What NOT to include
Don't include:
- Detailed API documentation (link to separate docs instead)
- Extensive troubleshooting guides (use wikis or separate documentation)
- License text (reference separate LICENSE file)
- Detailed contribution guidelines (reference separate CONTRIBUTING.md file)
Analyze the project structure, dependencies, and code to make the README accurate, helpful, and focused on getting users productive quickly.
이 프롬프트 파일을 사용하는 방법
- 위 콘텐츠를 리포지토리의
.github/prompts
폴더에create-readme.prompt.md
로 저장합니다. - Visual Studio Code에서 Copilot Chat 보기를 표시하고
/create-readme
를 입력합니다.
Further reading
- Use prompt files in Visual Studio Code in the Visual Studio Code documentation - Information on how to create and use prompt files
- GitHub Copilot Chat 응답 사용자 지정 정보 - Overview of response customization in GitHub Copilot
- Awesome GitHub Copilot Customizations - Repository of community-contributed custom prompt files and other customizations for specific languages and scenarios