Skip to content

Commit 6e5b002

Browse files
authored
Merge pull request #185 from TfTHacker/issue-template
chore: Add issue templates
2 parents b772b45 + 7ed073a commit 6e5b002

File tree

3 files changed

+133
-0
lines changed

3 files changed

+133
-0
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug report
2+
description: Report a bug and help improve the plugin
3+
title: "[BUG] Short description of the bug"
4+
labels: bug
5+
assignees: spasche
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Bug report
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: A clear and concise description of the bug. Include any relevant details.
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Steps to Reproduce
20+
description: Provide a step-by-step description.
21+
value: |
22+
1. Go to '...'
23+
2. Click on '...'
24+
3. Notice that '...'
25+
...
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Expected Behavior
31+
description: What did you expect to happen?
32+
validations:
33+
required: true
34+
- type: textarea
35+
attributes:
36+
label: Actual Behavior
37+
description: What actually happened? Include error messages if available.
38+
validations:
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: Environment Information
43+
description: Environment Information
44+
value: |
45+
- **Plugin Version**: [e.g., 1.0.0]
46+
- **Obsidian Version**: [e.g., v1.3.2]
47+
- **Operating System**: [e.g., Windows 10]
48+
validations:
49+
required: true
50+
- type: textarea
51+
attributes:
52+
label: Attachments
53+
description: Required for bug reproduction
54+
value: |
55+
- Please attach a video showing the bug. It is not mandatory, but might be very helpful to speed up the bug fix
56+
- Please attach a sample vault where the bug can be reproduced. It is not mandatory, but might be very helpful to speed up the bug fix
57+
validations:
58+
required: true
59+
- type: checkboxes
60+
attributes:
61+
label: Confirmations
62+
description: Ensure the following conditions are met
63+
options:
64+
- label: I attached a video showing the bug, or it is not necessary
65+
required: true
66+
- label: I attached a sample vault where the bug can be reproduced, or it is not necessary
67+
required: true
68+
- label: I have tested the bug with the latest version of the plugin
69+
required: true
70+
- label: I have checked GitHub for existing bugs
71+
required: true

.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
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Feature request
2+
description: Request a feature and help improve the plugin
3+
title: "[FR] Short description of the feature"
4+
labels: enhancement
5+
assignees: spasche
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Feature Request
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: A clear and concise description of the feature request. Include any relevant details.
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Details
20+
description: Provide a step-by-step description.
21+
value: |
22+
1. Go to '...'
23+
2. Click on '...'
24+
3. Notice that '...'
25+
...
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Desired Behavior
31+
description: What do you want to happen?
32+
validations:
33+
required: true
34+
- type: textarea
35+
attributes:
36+
label: Current Behavior
37+
description: What actually happens?
38+
validations:
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: Attachments
43+
description: Required for feature investigation
44+
value: |
45+
- Please attach a video showing the current behavior. It is not mandatory, but might be very helpful to speed up the feature implementation
46+
- Please attach a sample vault where the desired Feature Request could be applied. It is not mandatory, but might be very helpful to speed up the feature implementation
47+
validations:
48+
required: true
49+
- type: checkboxes
50+
attributes:
51+
label: Confirmations
52+
description: Ensure the following conditions are met
53+
options:
54+
- label: I attached a video showing the current behavior, or it is not necessary
55+
required: true
56+
- label: I attached a sample vault where the desired Feature Request could be applied, or it is not necessary
57+
required: true
58+
- label: I have tested the absence of the requested feature with the latest version of the plugin
59+
required: true
60+
- label: I have checked GitHub for existing Feature Requests
61+
required: true

0 commit comments

Comments
 (0)