Skip to content

Commit e13c74b

Browse files
authored
feat: Create GitHub Copilot instructions feedback template (#5176)
* feat: Create GitHub Copilot instructions feedback template Added a new issue template for GitHub Copilot instructions feedback, including fields for model used, prompt examples, issues encountered, expected behavior, suggestions for improvement, clarity rating, and context. * Fix label casing in issue template fields * Update .github/ISSUE_TEMPLATE/github_copilot_instructions.yaml * Enhance issue template with business unit fields Added dropdown and input fields for business unit and project information.
1 parent 16e4d67 commit e13c74b

File tree

1 file changed

+123
-0
lines changed

1 file changed

+123
-0
lines changed
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
name: 📄 GitHub Copilot Instructions feedback
2+
description: Share feedback about the `.github/copilot-instructions.md` documentation (model choice, prompt results, clarity, etc.).
3+
title: "[GitHub Copilot Instructions feedback]: "
4+
labels: [documentation, copilot]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to share your feedback! This form is to help us improve the `.github/copilot-instructions.md` documentation provided in the design system by using the [`@db-ux/agent-cli`](https://www.npmjs.com/package/@db-ux/agent-cli) node package.
10+
11+
Please keep in mind not to share any internal information or data this way. This includes internal URLs. Only use sample material.
12+
13+
- type: input
14+
id: model-used
15+
attributes:
16+
label: 🤖 Model you used
17+
description: Which model (if any) did you follow or reference from the documentation?
18+
placeholder: e.g. GPT-4o, Claude 2, Custom LLM, etc.
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
id: prompt-used
24+
attributes:
25+
label: 💬 Prompt or usage example
26+
description: Share the exact or approximate prompt or example you tried using, based on the documentation.
27+
placeholder: Copy/paste or summarize the input/prompt you used.
28+
validations:
29+
required: false
30+
31+
- type: textarea
32+
id: issue-description
33+
attributes:
34+
label: ❗ What didn’t work as expected?
35+
description: Describe what was confusing, broken, or didn’t meet your expectations. Be as detailed as possible.
36+
placeholder: Include any error messages, mismatches, unexpected behaviors, or missing context.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: expected-behavior
42+
attributes:
43+
label: ✅ What did you expect instead?
44+
description: What outcome were you hoping for or expecting based on the instructions provided?
45+
placeholder: Describe the result you thought you’d get.
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
id: suggestions
51+
attributes:
52+
label: 💡 Suggestions for improvement
53+
description: How could we make the documentation clearer, more accurate, or more helpful?
54+
placeholder: e.g. "Add a note about prompt structure", "Link to working examples", etc.
55+
validations:
56+
required: false
57+
58+
- type: dropdown
59+
id: ide
60+
attributes:
61+
label: 📝 Which IDE did you use?
62+
description: Please provide information on the IDE you've used.
63+
options:
64+
- Visual Studio Code
65+
- IntelliJ
66+
- Others (please provide more information in another field)
67+
validations:
68+
required: false
69+
70+
- type: dropdown
71+
id: clarity-rating
72+
attributes:
73+
label: 📝 How clear was the documentation?
74+
description: Rate how easy it was to follow the instructions.
75+
options:
76+
- 1 - Very unclear
77+
- 2 - Somewhat unclear
78+
- 3 - Neutral
79+
- 4 - Mostly clear
80+
- 5 - Very clear
81+
validations:
82+
required: false
83+
84+
- type: input
85+
id: link-or-context
86+
attributes:
87+
label: 🔗 Context (optional)
88+
description: If you're referencing a specific section or line in the documentation, include a link or brief context.
89+
placeholder: e.g. Line 32 in .github/copilot-instructions.md or a permalink to the file
90+
validations:
91+
required: false
92+
93+
- type: dropdown
94+
id: businessunit
95+
attributes:
96+
label: Which DB business unit do you work for?
97+
options:
98+
- DB Systel GmbH (please name your customer below)
99+
- DB Fernverkehr AG
100+
- DB Regio AG
101+
- DB InfraGO AG
102+
- DB Cargo AG
103+
- DB Konzern
104+
- DB Vertrieb GmbH
105+
- DB Energie
106+
- DB Connect
107+
- other (please specify below)
108+
validations:
109+
required: false
110+
111+
- type: input
112+
id: businessunit2
113+
attributes:
114+
label: ”DB Systel” please enter your customer / ”other” please enter your area or business unit.
115+
validations:
116+
required: false
117+
118+
- type: input
119+
id: project
120+
attributes:
121+
label: What project are you working on?
122+
validations:
123+
required: false

0 commit comments

Comments
 (0)