Skip to content

Commit 279acb7

Browse files
authored
Merge pull request #40199 from github/repo-sync
Repo sync
2 parents 4a6c548 + 05267a8 commit 279acb7

File tree

2 files changed

+151
-0
lines changed

2 files changed

+151
-0
lines changed
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
title: Creating templates
3+
shortTitle: Create templates
4+
intro: '{% data variables.copilot.copilot_chat_short %} can help you create templates to streamline your workflow and ensure consistency across your projects.'
5+
versions:
6+
feature: copilot
7+
category:
8+
- Communicate effectively
9+
complexity:
10+
- Simple
11+
octicon: copilot
12+
topics:
13+
- Copilot
14+
contentType: tutorials
15+
---
16+
17+
{% data variables.copilot.copilot_chat %} can help you create templates for various purposes, such as project documentation, code snippets, or issue tracking. By using templates, you can streamline your workflow and ensure consistency across your projects.
18+
19+
## Example scenario
20+
21+
You want to create a template for a project README file that includes sections for project description, installation instructions, usage examples, and contribution guidelines. You can ask {% data variables.copilot.copilot_chat_short %} to generate a README template based on best practices and your specific requirements. You can then use this template as a starting point for all your project documentation.
22+
23+
## Example prompt
24+
25+
```text copy
26+
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.
27+
```
28+
29+
## Example response
30+
31+
{% data reusables.copilot.example-prompts.response-is-an-example %}
32+
33+
{% data variables.product.prodname_copilot_short %} will provide you with a structured README template. You can copy the template {% data variables.copilot.copilot_chat_short %} provides and customize it further to fit your project's needs.
34+
35+
````markdown
36+
# Project Name
37+
38+
> **Short description:**
39+
> A brief summary of what your project does, its main features, and its purpose.
40+
41+
---
42+
43+
## Table of Contents
44+
45+
- [Description](#description)
46+
- [Installation](#installation)
47+
- [Usage](#usage)
48+
- [Contributing](#contributing)
49+
- [License](#license)
50+
- [Contact](#contact)
51+
52+
---
53+
54+
## Description
55+
56+
Provide a detailed explanation of what your project does, why it exists, and any important background information.
57+
You may want to include:
58+
- Key features
59+
- Supported platforms or languages
60+
- Screenshots or diagrams
61+
62+
---
63+
64+
## Installation
65+
66+
1. **Clone the repository**
67+
```sh
68+
git clone https://github.com/your-username/your-repo-name.git
69+
cd your-repo-name
70+
```
71+
72+
2. **Install dependencies**
73+
```sh
74+
# Example for Node.js projects
75+
npm install
76+
77+
# Example for Python projects
78+
pip install -r requirements.txt
79+
```
80+
81+
3. **Additional setup**
82+
- List any other required steps (e.g., environment variables, configuration files)
83+
84+
---
85+
86+
## Usage
87+
88+
Provide clear usage instructions and code examples.
89+
90+
```sh
91+
# Example command
92+
your-command --option value
93+
```
94+
95+
```python
96+
# Example in Python
97+
import your_module
98+
99+
result = your_module.do_something()
100+
print(result)
101+
```
102+
103+
- Explain any CLI options, configuration, or parameters.
104+
- Link to more detailed documentation if available.
105+
106+
---
107+
108+
## Contributing
109+
110+
Contributions are welcome! Please follow these guidelines:
111+
112+
1. **Fork the repository**
113+
2. **Create a new branch**
114+
```sh
115+
git checkout -b feature/your-feature-name
116+
```
117+
3. **Make your changes**
118+
4. **Test your changes**
119+
5. **Commit and push**
120+
```sh
121+
git commit -m "Add feature: your-feature-name"
122+
git push origin feature/your-feature-name
123+
```
124+
6. **Open a pull request**
125+
126+
**Code of Conduct:**
127+
Please be respectful and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
128+
129+
**Issues & Suggestions:**
130+
Open an issue for bugs, questions, or feature requests.
131+
132+
---
133+
134+
## License
135+
136+
This project is licensed under the [INSERT LICENSE](link to relevant license information).
137+
138+
---
139+
140+
## Contact
141+
142+
- **Maintainer:** [Your Name](mailto:your@email.com)
143+
- **Project Link:** https://github.com/your-username/your-repo-name
144+
145+
---
146+
````
147+
148+
## Further reading
149+
150+
{% data reusables.copilot.example-prompts.further-reading-items %}

content/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ topics:
77
- Copilot
88
children:
99
- /creating-diagrams
10+
- /creating-templates
1011
- /extracting-information
1112
- /synthesizing-research
1213
contentType: tutorials

0 commit comments

Comments
 (0)