Skip to content

Commit 6191b5f

Browse files
purejavapurejava
committed
Add issue templates
1 parent 36f163b commit 6191b5f

3 files changed

Lines changed: 114 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Bug Report
2+
description: Create a report to help us improve the software
3+
labels: ["bug"]
4+
body:
5+
- type: checkboxes
6+
id: terms
7+
attributes:
8+
label: Please agree to the following
9+
options:
10+
- label: I have searched [existing issues](https://github.com/purejava/winsparkle-java/issues?q=) for duplicates
11+
required: true
12+
- type: input
13+
id: summary
14+
attributes:
15+
label: Summary
16+
placeholder: Please summarize your problem.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: software-versions
21+
attributes:
22+
label: What software is involved?
23+
description: |
24+
Examples:
25+
- Operating System: Windows 11
26+
- winsparkle-java: 0.0.1
27+
value: |
28+
- Operating System:
29+
- winsparkle-java:
30+
- …
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: reproduction-steps
35+
attributes:
36+
label: Steps to Reproduce
37+
value: |
38+
1. [First Step]
39+
2. [Second Step]
40+
3. …
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: expected-behaviour
45+
attributes:
46+
label: Expected Behavior
47+
placeholder: What you expect to happen.
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: actual-behaviour
52+
attributes:
53+
label: Actual Behavior
54+
placeholder: What actually happens.
55+
validations:
56+
required: true
57+
- type: dropdown
58+
id: reproducibility
59+
attributes:
60+
label: Reproducibility
61+
description: How often does the described behaviour occur?
62+
options:
63+
- Always
64+
- Intermittent
65+
- Only once
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: logs
70+
attributes:
71+
label: Relevant Log Output
72+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
73+
render: shell
74+
- type: textarea
75+
id: further-info
76+
attributes:
77+
label: Anything else?
78+
description: Links? References? Screenshots? Configurations? Any data that might be necessary to reproduce the issue?

‎.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: false

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Feature Request
2+
description: Suggest an idea for this plugin
3+
labels: ["feature-request"]
4+
body:
5+
- type: checkboxes
6+
id: terms
7+
attributes:
8+
label: Please agree to the following
9+
options:
10+
- label: I have searched [existing issues](https://github.com/purejava/winsparkle-java/issues?q=) for duplicates
11+
required: true
12+
- type: input
13+
id: summary
14+
attributes:
15+
label: Summary
16+
placeholder: Please summarize your feature request.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: motivation
21+
attributes:
22+
label: Motivation
23+
description: Who requires this feature? What problem does the user face? How would this feature solve the problem?
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Considered Alternatives
30+
description: What current alternatives or workarounds have you considered? Is there a different way to solve the same problem?
31+
- type: textarea
32+
id: context
33+
attributes:
34+
label: Anything else?
35+
description: Any context, suggestions, screenshots, or concepts you want to share?

0 commit comments

Comments
 (0)