Skip to content

Commit c40cf95

Browse files
authored
Merge pull request #510 from carpentries-incubator/issue_templates
Add 3 issue templates (workshop instance, bug, content improvement).
2 parents 00ee2d2 + ef7efe7 commit c40cf95

3 files changed

Lines changed: 120 additions & 0 deletions

File tree

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Report a problem
2+
description: Tell us about something that needs to be fixed
3+
body:
4+
- type: textarea
5+
id: details
6+
attributes:
7+
label: What is the problem?
8+
description: Please provide details, to make it easier for the maintainers and other community members to address the issue.
9+
validations:
10+
required: true
11+
- type: input
12+
id: location
13+
attributes:
14+
label: Location of problem (optional)
15+
description: Where is the problem that needs to be fixed? (e.g. the name of the source file or the URL(s) of the webpage(s))
16+
- type: markdown
17+
attributes:
18+
value: >
19+
Thank you for taking time to tell us about a problem in this lesson!
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Suggest a curriculum-wide or episode-specific improvement
2+
description: Tell us about how the content of the curriculum as a whole could be improved
3+
body:
4+
- type: textarea
5+
id: details
6+
attributes:
7+
label: How could the content be improved?
8+
description: Please provide details of the improvement you are suggesting, to make it easier for the maintainers and other community members to address the issue.
9+
validations:
10+
required: true
11+
- type: input
12+
id: location-details
13+
attributes:
14+
label: Which part of the content or episode does your suggestion apply to (unless it is curriculum-wide improvement)?
15+
description: Please provide a URL, the title of the relevant section or page, a filename, etc.
16+
- type: markdown
17+
attributes:
18+
value: >
19+
Thank you for taking time to suggest an improvement to this lesson!
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Workshop Details and Feedback
2+
description: Share details, number of participants and feedback from a workshop that you are planning to deliver or have delivered recently.
3+
title: "[Workshop details and feedback]: "
4+
labels: ["type:discussion"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for planning to teach or teaching this lesson and agreeing to share feedback!
10+
Please answer the questions below,
11+
and note that feedback submitted with this form will be publicly visible.
12+
If you do not have any feedback to share at the moment (e.g. you have not delivered the workshop yet) -
13+
you can come back to this issue later and fill in the missing details.
14+
- type: textarea
15+
id: workshop
16+
attributes:
17+
label: 1. Workshop details
18+
description: |
19+
Tell us about the workshop.
20+
When and where is it taking place/did it take place? Who will host/hosted it? Who were the Instructors?
21+
How many Learners were there? What was/is background of the Learners, e.g. their career stage, domain, prior knowledge of the lesson topics?
22+
validations:
23+
required: true
24+
- type: markdown
25+
attributes:
26+
value: |
27+
## Instructor Feedback
28+
- type: textarea
29+
id: instructor-up
30+
attributes:
31+
label: 2. What did the Instructors find worked well when teaching the lesson?
32+
description: |
33+
What was good about the content and/or the design of the lesson?
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: instructor-down
38+
attributes:
39+
label: 3. What did the Instructors find that could be improved in the lesson?
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: instructor-other
44+
attributes:
45+
label: 4. Do the Instructors have any other feedback on the lesson?
46+
- type: dropdown
47+
id: time
48+
attributes:
49+
label: 5. Were the Instructors able to teach the whole lesson in the time available?
50+
options:
51+
- "Not sure"
52+
- "Yes"
53+
- "No"
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: time-details
58+
attributes:
59+
label: 6. Tell us more about the lesson duration
60+
description: |
61+
If the Instructors were not able to teach the complete lesson in the time available, how much time did they have and how far through the lesson did they get?
62+
What content, if any, did they skip when teaching the lesson?
63+
If they were able to teach the whole lesson, how much time did it take?
64+
If an episode-by-episode breakdown of the time taken was recorded, please share it here.
65+
- type: markdown
66+
attributes:
67+
value: |
68+
## Learner Feedback
69+
- type: textarea
70+
id: learner-feedback
71+
attributes:
72+
label: 7. Please share any feedback collected from Learners during the lesson pilot.
73+
description: |
74+
Feel free to exclude any feedback that is specific to the Instructors, venue, etc, or about other lessons taught at the workshop.
75+
- type: markdown
76+
attributes:
77+
value: |
78+
## Conclusion
79+
- type: textarea
80+
id: other
81+
attributes:
82+
label: 8. Is there anything else you would like to tell us?

0 commit comments

Comments
 (0)