Skip to content

Commit 021d0e9

Browse files
committed
Add template for documentation issues
1 parent a76db4e commit 021d0e9

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Project or paper documentation
2+
description: Provide information about a project or paper for the MESSAGE team.
3+
title: "Document "
4+
labels: ["doc", "paper"]
5+
projects: ["MESSAGEix team"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Thanks for taking the time to fill out this documentation issue!
11+
12+
Please complete the issue title with the name of the project or paper you're documenting.
13+
Please answer as many of the following points as you can, but no worries if you don't have all the answers right away.
14+
These prompts mainly serve as a reminder as to what people may want to know.
15+
Feel free to update this issue whenever you have more answers and the time :smiley:
16+
Please remember to close this issue once the project is complete.
17+
- type: textarea
18+
id: who
19+
attributes:
20+
label: Who is responsible?
21+
description: Please tell us who's responsible for the project. If they have GitHub accounts, please assign them on this issue.
22+
placeholder: Me, myself, and I.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: what
27+
attributes:
28+
label: What's the goal?
29+
description: Please tell us what this project is about.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: when
34+
attributes:
35+
label: When does the project end?
36+
description: Please tell us the timeframe of this project.
37+
- type: textarea
38+
id: where
39+
attributes:
40+
label: Where does the project live?
41+
description: Please tell us where we can find the code and data this project is using.
42+
- type: textarea
43+
id: why
44+
attributes:
45+
label: Why is this project important?
46+
description: If you feel so inclined, please provide background information.
47+
- type: textarea
48+
id: state
49+
attributes:
50+
label: What's the current state of the work?
51+
description: "Please tell us what has been done already. If the project Scenario's follow a specific naming convention, this is a good place to highlight it :smiley:"
52+
- type: textarea
53+
id: more
54+
attributes:
55+
label: "For further information, see:"
56+
description: Please tell us where we can learn more about this project.

0 commit comments

Comments
 (0)