Skip to content

Commit ded08d4

Browse files
authored
Add feedback issue template for CodeMetaSoft tools
This template allows users to provide feedback on various CodeMetaSoft tools, including sw-metadata-bot and RSMetaCheck. It includes fields for user role, use case, overall experience, and suggestions for improvement.
1 parent 3bd08bb commit ded08d4

1 file changed

Lines changed: 154 additions & 0 deletions

File tree

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
name: "💬 Early Adopter Feedback"
2+
description: >
3+
Share your experience using sw-metadata-bot, RSMetaCheck, or any CodeMetaSoft tool.
4+
Your feedback directly shapes the project roadmap.
5+
labels: ["feedback", "early-adopter"]
6+
title: "[Feedback] <brief summary of your experience>"
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
## Thanks for using CodeMetaSoft tools! 🎉
13+
14+
This form covers feedback for:
15+
- **[sw-metadata-bot](https://github.com/SoftwareUnderstanding/sw-metadata-bot)** — the GitHub/GitLab metadata bot
16+
- **[RSMetaCheck](https://github.com/SoftwareUnderstanding/RsMetaCheck)** — the metadata analysis tool
17+
- **[CodeMetaSoft project tools](https://softwareunderstanding.github.io/CodeMetaSoft_website/website/)** — any other tool in the ecosystem
18+
19+
Be as specific as possible. Vague feedback is hard to act on.
20+
21+
- type: dropdown
22+
id: tool
23+
attributes:
24+
label: "Which tool are you providing feedback on?"
25+
description: Select the tool(s) you used.
26+
multiple: true
27+
options:
28+
- sw-metadata-bot (GitHub/GitLab bot)
29+
- RSMetaCheck (CLI / analysis tool)
30+
- Autocodemeta
31+
- Somef
32+
- Other CodeMetaSoft tool
33+
validations:
34+
required: true
35+
36+
- type: dropdown
37+
id: role
38+
attributes:
39+
label: "Your role"
40+
description: How do you interact with these tools?
41+
options:
42+
- Repository maintainer (received a bot issue)
43+
- Research Software Engineer (RSE)
44+
- Researcher / scientist
45+
- Infrastructure / platform operator
46+
- Other
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: use-case
52+
attributes:
53+
label: "Describe your use case"
54+
description: What were you trying to do? What repository / project did you use the tool on?
55+
placeholder: |
56+
e.g., "I received a bot issue on my Python library for CTA data analysis.
57+
The bot flagged missing CITATION.cff and incomplete codemeta.json."
58+
validations:
59+
required: true
60+
61+
- type: dropdown
62+
id: overall-rating
63+
attributes:
64+
label: "Overall experience"
65+
options:
66+
- "⭐ Very useful — solved my problem"
67+
- "👍 Useful — minor friction"
68+
- "😐 Neutral — unclear value"
69+
- "👎 Not useful — missed the point"
70+
- "🚫 Broken — could not use it"
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: what-worked
76+
attributes:
77+
label: "What worked well?"
78+
description: Be specific. Which suggestion, output, or workflow was helpful?
79+
placeholder: "e.g., The codemeta.json suggestion was accurate and ready to use."
80+
81+
- type: textarea
82+
id: what-didnt-work
83+
attributes:
84+
label: "What did NOT work or was confusing?"
85+
description: >
86+
Be specific. Include error messages, wrong detections, or unclear guidance.
87+
If the bot flagged something incorrectly, explain what and why.
88+
placeholder: |
89+
e.g., "P002 was flagged but our LICENSE already had correct author info.
90+
The check seems to match a regex without reading the actual content."
91+
92+
- type: textarea
93+
id: missing
94+
attributes:
95+
label: "What is missing?"
96+
description: Features, checks, integrations, or documentation you expected but didn't find.
97+
placeholder: "e.g., No support for REUSE/SPDX license format detection."
98+
99+
- type: dropdown
100+
id: false-positives
101+
attributes:
102+
label: "Did you receive incorrect suggestions (false positives)?"
103+
options:
104+
- "No, all suggestions were accurate"
105+
- "1–2 minor false positives"
106+
- "Several false positives — noticeable friction"
107+
- "Mostly false positives — tool was not useful"
108+
- "Not applicable / did not check"
109+
validations:
110+
required: true
111+
112+
- type: textarea
113+
id: false-positive-details
114+
attributes:
115+
label: "False positive details (if any)"
116+
description: >
117+
Which rule ID(s) fired incorrectly? Include the rule code (e.g., P002, W005) if known.
118+
placeholder: "e.g., W003 triggered even though we have an active DOI in the README."
119+
120+
- type: dropdown
121+
id: would-recommend
122+
attributes:
123+
label: "Would you recommend this tool to a colleague?"
124+
options:
125+
- "Yes, definitely"
126+
- "Yes, with reservations"
127+
- "Not sure"
128+
- "No"
129+
validations:
130+
required: true
131+
132+
- type: textarea
133+
id: suggestions
134+
attributes:
135+
label: "Any specific suggestions for improvement?"
136+
description: Concrete and actionable is best.
137+
placeholder: "e.g., Add a dry-run mode so I can preview suggestions before they become issues."
138+
139+
- type: input
140+
id: repo-url
141+
attributes:
142+
label: "Repository URL (optional)"
143+
description: Share the repo the bot analyzed, if you're comfortable doing so.
144+
placeholder: "https://github.com/your-org/your-repo"
145+
146+
- type: checkboxes
147+
id: consent
148+
attributes:
149+
label: "Consent"
150+
options:
151+
- label: >
152+
I agree this feedback may be used to improve CodeMetaSoft tools.
153+
I understand it will be publicly visible on this GitHub repository.
154+
required: true

0 commit comments

Comments
 (0)