GitHub Copilot 채팅를 사용하면 project 설명서, 코드 조각 또는 문제 추적과 같은 다양한 용도로 템플릿을 만들 수 있습니다. 템플릿을 활용하면 워크플로를 간소화하고 전체 프로젝트의 일관성을 유지할 수 있습니다.
예제 시나리오
project 설명, 설치 지침, 사용 예제 및 기여 지침에 대한 섹션이 포함된 project 추가 정보 파일에 대한 템플릿을 만들려고 합니다. Copilot 채팅에게 모범 사례 및 특정 요구 사항을 토대로 추가 정보 템플릿을 만들도록 요청할 수 있습니다. 그런 다음 이 템플릿을 모든 project 설명서의 시작점으로 사용할 수 있습니다.
예시 프롬프트
Create a README template for a new open-source project that includes sections for project description, installation instructions, usage examples, and contribution guidelines. Make it clear and easy to follow.
Create a README template for a new open-source project that includes sections for project description, installation instructions, usage examples, and contribution guidelines. Make it clear and easy to follow.
예제 응답
참고
다음 응답이 예제입니다. Copilot 채팅 응답은 비결정적이므로 여기에 표시된 응답과 다른 응답을 얻을 수 있습니다.
Copilot에서는 구조화된 추가 정보 템플릿을 이용할 수 있습니다. 템플릿을 Copilot 채팅에서 복사하고 프로젝트 요구에 맞게 추가로 사용자 지정할 수 있습니다.
# Project Name
> **Short description:**
> A brief summary of what your project does, its main features, and its purpose.
---
## Table of Contents
- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
---
## Description
Provide a detailed explanation of what your project does, why it exists, and any important background information.
You may want to include:
- Key features
- Supported platforms or languages
- Screenshots or diagrams
---
## Installation
1. **Clone the repository**
```sh
git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name
```
2. **Install dependencies**
```sh
# Example for Node.js projects
npm install
# Example for Python projects
pip install -r requirements.txt
```
3. **Additional setup**
- List any other required steps (e.g., environment variables, configuration files)
---
## Usage
Provide clear usage instructions and code examples.
```sh
# Example command
your-command --option value
```
```python
# Example in Python
import your_module
result = your_module.do_something()
print(result)
```
- Explain any CLI options, configuration, or parameters.
- Link to more detailed documentation if available.
---
## Contributing
Contributions are welcome! Please follow these guidelines:
1. **Fork the repository**
2. **Create a new branch**
```sh
git checkout -b feature/your-feature-name
```
3. **Make your changes**
4. **Test your changes**
5. **Commit and push**
```sh
git commit -m "Add feature: your-feature-name"
git push origin feature/your-feature-name
```
6. **Open a pull request**
**Code of Conduct:**
Please be respectful and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
**Issues & Suggestions:**
Open an issue for bugs, questions, or feature requests.
---
## License
This project is licensed under the [INSERT LICENSE](link to relevant license information).
---
## Contact
- **Maintainer:** [Your Name](mailto:your@email.com)
- **Project Link:** https://github.com/your-username/your-repo-name
---
추가 참고 자료
데이터 재사용 가능.코파일럿.예제-프롬프트.추가-읽기-항목 %}