Skip to content

Commit 32c88c5

Browse files
committed
update issue templates
1 parent 8cb0874 commit 32c88c5

File tree

3 files changed

+81
-18
lines changed

3 files changed

+81
-18
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,29 @@ body:
77
attributes:
88
value: >-
99
Thanks for taking the time to fill out this bug report!
10-
11-
10+
11+
1212
By filling out the form you are giving me a clear description of the
1313
bug, which helps me to fix the bug more quickly. :)
1414
- type: checkboxes
1515
id: latest-version-check
1616
attributes:
1717
label: Please fill out these Check-boxes
1818
options:
19+
- label: I checked for existing similar issues
20+
required: true
1921
- label: I checked that the plugin is up to date
2022
required: true
2123
- label: The issue persist with all other plugins and themes disabled
2224
required: false
25+
- type: input
26+
id: plugin-version
27+
attributes:
28+
label: Plugin Version
29+
description: Please enter the plugin version you are using in the textbox below.
30+
placeholder: x.x.x
31+
validations:
32+
required: true
2333
- type: checkboxes
2434
id: operating-systems
2535
attributes:
@@ -36,12 +46,14 @@ body:
3646
required: false
3747
- label: iOS
3848
required: false
39-
- type: input
40-
id: plugin-version
49+
- type: textarea
50+
id: debug-info
4151
attributes:
42-
label: Plugin Version
43-
description: Please enter the plugin version you are using in the textbox below.
44-
placeholder: x.x.x
52+
label: Debug Info
53+
description: >-
54+
Please run the "Show debug info" command in your Obsidian Vault and copy
55+
it's output here.
56+
render: text
4557
validations:
4658
required: true
4759
- type: textarea
@@ -58,11 +70,7 @@ body:
5870
attributes:
5971
label: Steps to Reproduce
6072
description: Please provide simple steps to reproduce the behavior.
61-
placeholder: >-
62-
1. Go to '...'
63-
2. Click on '....'
64-
3. Scroll down to '....'
65-
4. See error
73+
placeholder: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error
6674
validations:
6775
required: true
6876
- type: textarea
@@ -78,3 +86,8 @@ body:
7886
value: >-
7987
This template was generated with [Issue Forms
8088
Creator](https://issue-forms-creator.netlify.app)
89+
- type: markdown
90+
attributes:
91+
value: >-
92+
This template was generated with [Issue Forms
93+
Creator](https://issue-forms-creator.netlify.app)
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Documentation
2+
description: Report an issue or enhancement for the documentation website.
3+
labels:
4+
- documentation
5+
body:
6+
- type: input
7+
id: site
8+
attributes:
9+
label: Page
10+
description: Please provide the link of the page.
11+
placeholder: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/...
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: main
16+
attributes:
17+
label: Issue or Enhancement
18+
description: Please describe the issue or suggested enhancement for the page above.
19+
validations:
20+
required: true
21+
- type: markdown
22+
attributes:
23+
value: >-
24+
This template was generated with [Issue Forms
25+
Creator](https://issue-forms-creator.netlify.app)

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,43 @@ description: Suggest a new feature for this plugin.
33
labels:
44
- feature request
55
body:
6+
- type: checkboxes
7+
id: checks
8+
attributes:
9+
label: Please fill out these Check-boxes
10+
options:
11+
- label: I checked for existing similar feature requests
12+
required: true
13+
- label: >-
14+
I have read the docs and checked that the feature I am requesting is
15+
not already implemented
16+
required: true
17+
- label: My feature request consists of only one feature
18+
required: true
619
- type: textarea
720
id: related-problem
821
attributes:
9-
label: Is your Feature Request Related to a Problem?
22+
label: Is your Feature Request related to a Problem or Annoyance?
1023
description: >-
11-
If your feature request is related to a problem, please provide clear
12-
and concise description the problem.
13-
placeholder: " I'm always frustrated when..."
24+
If your feature request is related to a problem or annoyance, please
25+
describe it.
26+
placeholder: ' I''m always frustrated when...'
1427
- type: textarea
1528
attributes:
16-
label: Describe the Feature you'd Like
29+
label: Describe the Feature you'd like
1730
description: >-
1831
Please provide a clear and concise description of the feature that you
19-
would like.
32+
would like, how it should function, and how it solves the above problem
33+
(if applicable).
2034
placeholder: I would like the plugin to be able to do...
2135
validations:
2236
required: true
37+
- type: textarea
38+
id: alternatives
39+
attributes:
40+
label: Alternatives
41+
description: Please describe any alternatives you have considered.
42+
placeholder: Instead the plugin could...
2343
- type: textarea
2444
id: additional-context
2545
attributes:
@@ -30,3 +50,8 @@ body:
3050
value: >-
3151
This template was generated with [Issue Forms
3252
Creator](https://issue-forms-creator.netlify.app)
53+
- type: markdown
54+
attributes:
55+
value: >-
56+
This template was generated with [Issue Forms
57+
Creator](https://issue-forms-creator.netlify.app)

0 commit comments

Comments
 (0)