Skip to content

Commit b2da1cc

Browse files
glatterf42khaeru
authored andcommitted
Add template for documentation issues
1 parent 945afcb commit b2da1cc

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-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: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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+
> [!NOTE]
13+
> Please complete the issue title with the name of the project or paper you're documenting.
14+
> Please answer as many of the following points as you can, but no worries if you don't have all the answers right away.
15+
> These prompts mainly serve as a reminder as to what people may want to know.
16+
> Feel free to update this issue whenever you have more answers and the time :smiley:
17+
> Please remember to close this issue once the project is complete.
18+
- type: textarea
19+
id: who
20+
attributes:
21+
label: Who is responsible?
22+
description: Please tell us who's responsible for the project. If they have GitHub accounts, please assign them on this issue.
23+
placeholder: Me, myself, and I.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: what
28+
attributes:
29+
label: What's the goal?
30+
description: Please tell us what this project is about.
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: when
35+
attributes:
36+
label: When does the project end?
37+
description: Please tell us the timeframe of this project.
38+
- type: textarea
39+
id: where
40+
attributes:
41+
label: Where does the project live?
42+
description: Please tell us where we can find the code and data this project is using.
43+
- type: textarea
44+
id: why
45+
attributes:
46+
label: Why is this project important?
47+
description: If you feel so inclined, please provide background information.
48+
- type: textarea
49+
id: state
50+
attributes:
51+
label: What's the current state of the work?
52+
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:"
53+
- type: textarea
54+
id: more
55+
attributes:
56+
label: "For further information, see:"
57+
description: Please tell us where we can learn more about this project.

0 commit comments

Comments
 (0)