GitHub Copilot 채팅을 사용하면 프로젝트 문서, 코드 조각, 이슈 추적과 같은 다양한 목적에 맞는 템플릿을 만드는 데 도움이 됩니다. 템플릿을 사용하면 워크플로를 간소화하고 프로젝트 전체에서 일관성을 보장할 수 있습니다.
예제 시나리오
프로젝트 설명, 설치 지침, 사용 예, 기여 지침에 대한 섹션을 포함하는 프로젝트 추가 정보 파일 템플릿을 만들려고 합니다. Copilot Chat에 모범 사례와 특정 요구 사항을 기반으로 추가 정보 템플릿을 생성하도록 요청할 수 있습니다. 그런 다음, 이 템플릿을 모든 프로젝트 문서의 시작점으로 사용할 수 있습니다.
예시 프롬프트
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 Chat 응답은 비결정적이므로 여기에 표시된 응답과 다른 응답을 얻을 수 있습니다.
Copilot은 구조화된 추가 정보 템플릿을 제공합니다. Copilot Chat에서 제공하는 템플릿을 복사하여 프로젝트 요구 사항에 맞게 추가로 사용자 지정할 수 있습니다.
# 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
---