Skip to content

Commit 38d3ab3

Browse files
Update Contributing Guide (#301)
* Update Contributing Guide * Update CONTRIBUTING.md with usage examples Added examples for edge-ai tasks collection usage.
1 parent e868e71 commit 38d3ab3

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,41 @@ items:
135135
kind: instruction
136136
- path: chatmodes/my-chatmode.chatmode.md
137137
kind: chat-mode
138+
usage: |
139+
recommended # or "optional" if not essential to the workflow
140+
141+
This chat mode requires the following instructions/prompts/MCPs:
142+
- Instruction 1
143+
- Prompt 1
144+
- MCP 1
145+
146+
This chat mode is ideal for...
147+
- Use case 1
148+
- Use case 2
149+
150+
Here is an example of how to use it:
151+
```markdown, task-plan.prompt.md
152+
---
153+
mode: task-planner
154+
title: Plan microsoft fabric realtime intelligence terraform support
155+
---
156+
#file: <file including in chat context>
157+
Do an action to achieve goal.
158+
```
159+
160+
To get the best results, consider...
161+
- Tip 1
162+
- Tip 2
163+
138164
display:
139165
ordering: alpha # or "manual" to preserve order above
140166
show_badge: false # set to true to show collection badge
141167
```
142168
169+
For full example of usage checkout edge-ai tasks collection:
170+
- [edge-ai-tasks.collection.yml](./collections/edge-ai-tasks.collection.yml)
171+
- [edge-ai-tasks.md](./collections/edge-ai-tasks.md)
172+
143173
#### Collection Guidelines
144174
145175
- **Focus on workflows**: Group items that work together for specific use cases

0 commit comments

Comments
 (0)