Skip to content

Commit f412ad8

Browse files
authored
Convert issue templates to issue forms (#1158)
* Convert bug report template to issue form * Convert feature request template to issue form * Convert documentation request template to issue form * refactor(feature-request): rename textarea to Feature Description * refactor(documentation-request): rename textarea to Documentation Description
1 parent 1388a66 commit f412ad8

File tree

6 files changed

+107
-81
lines changed

6 files changed

+107
-81
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 0 additions & 46 deletions
This file was deleted.
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Bug Report
2+
description: Bugs in AMP, the instance manager, or official AMP modules.
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please only include one issue per post! Do not try and bring up multiple requests in a single post.
9+
- type: input
10+
attributes:
11+
label: Operating System
12+
description: Include distribution name and version number.
13+
placeholder: Debian 12.6.0
14+
validations:
15+
required: true
16+
- type: input
17+
attributes:
18+
label: AMP Version and Build Date
19+
description: |
20+
Always use the version number, 'latest' is not valid!
21+
placeholder: 2.5.1.6 - 20240816.1
22+
validations:
23+
required: true
24+
- type: dropdown
25+
attributes:
26+
label: AMP Release Stream
27+
options:
28+
- LTS
29+
- Mainline
30+
- Preview
31+
- Development
32+
validations:
33+
required: true
34+
- type: checkboxes
35+
attributes:
36+
label: I confirm that
37+
options:
38+
- label: I have searched for an existing bug report for this issue.
39+
required: true
40+
- label: I am using the latest available version of AMP.
41+
required: true
42+
- label: my operating system is up-to-date.
43+
required: true
44+
- type: textarea
45+
attributes:
46+
label: Intended Action
47+
description: What are you trying to do?
48+
validations:
49+
required: true
50+
- type: textarea
51+
attributes:
52+
label: Expected Behaviour
53+
description: What are you expecting to happen?
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Actual Behaviour
59+
description: |
60+
What is actually happening? 'Nothing' is not an acceptable answer!
61+
validations:
62+
required: true
63+
- type: textarea
64+
attributes:
65+
label: Reproduction
66+
description: |
67+
Starting from a clean install, how do you reproduce the issue that causes the symptoms described above? Imagine you're describing the problem to someone who has no idea what AMP is and needs to recreate the issue themselves.
68+
validations:
69+
required: true

.github/ISSUE_TEMPLATE/documentation-request.md

Lines changed: 0 additions & 14 deletions
This file was deleted.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Documentation Request
2+
description: To request documentation on a given aspect of AMP.
3+
labels: [documentation]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please include the following:
9+
* Links to any existing documentation if it exists but is unclear.
10+
* Information on what feature/aspect of AMP needs documenting.
11+
* What you're currently trying to do with AMP that has led you to require the given feature.
12+
* Some background on what information you might like to see in the documentation.
13+
- type: textarea
14+
attributes:
15+
label: Documentation Description
16+
description: Describe your request.
17+
validations:
18+
required: true

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 21 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature Request
2+
description: To request new features for either AMP or one of its application modules.
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Note that this is not for requesting support for new games/applications. To do this you should go to https://github.com/CubeCoders/AMPTemplates and first attempt to build a configuration yourself - otherwise you can request a template from that repo.
9+
- type: checkboxes
10+
attributes:
11+
label: I confirm that
12+
options:
13+
- label: I have searched for an existing feature request matching the description.
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Feature Description
18+
description: Describe your request.
19+
validations:
20+
required: true

0 commit comments

Comments
 (0)