Skip to content

Commit 29993b7

Browse files
Fix tutorial template (#626)
* thx * Update tutorial request template to include example for resource links * unique ids * update placeholders and validations
1 parent 82ca217 commit 29993b7

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

.github/ISSUE_TEMPLATE/tutorial_request.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,25 @@ description: Submit a request for a new tutorial to be added to the Gambit docum
33
title: "[Tutorial]: "
44
labels: ["tutorial", "documentation"]
55
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this tutorial request!
610
- type: textarea
711
id: describe
812
attributes:
913
label: Describe the tutorial you want to see.
1014
description: Go into as much detail as you can regarding the tutorial you would like to see, how long it should be etc.
15+
placeholder: "E.g. A step-by-step guide showing how to use PyGambit to compute equilibria for normal and extensive form games..."
1116
value: "Add a tutorial demonstrating the core components of the PyGambit API."
1217
validations:
1318
required: true
1419
- type: textarea
15-
id: describe
20+
id: who
1621
attributes:
1722
label: Who is the tutorial for?
1823
description: Explain who the target audience is for this tutorial and what prior knowledge they should have.
24+
placeholder: "E.g. Beginners in game theory who know basic Python."
1925
value: "Newcomers to game theory and the Gambit software who have basic Python programming skills."
2026
validations:
2127
required: true
@@ -24,4 +30,6 @@ body:
2430
attributes:
2531
label: Add links to papers and software.
2632
description: Add links to any research papers or other resources the author will need to write this tutorial.
27-
value: ""
33+
value: "`[Markdown link text](url)`"
34+
validations:
35+
required: false

0 commit comments

Comments
 (0)