Skip to content

Commit c9b6dbc

Browse files
JohannesKaufmannJohannesKaufmann
committed
github: add issue forms
1 parent 35518ba commit c9b6dbc

File tree

5 files changed

+263
-30
lines changed

5 files changed

+263
-30
lines changed

‎.github/ISSUE_TEMPLATE/01-cli-bug-report.yaml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
2+
name: 🐛 CLI Bug Report
3+
description: File a bug report for the command line interface.
4+
5+
title: "[CLI]: Your title"
6+
labels: ["bug", "cli"]
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
### Thank you for contributing to the project!
13+
14+
You are creating a issue for the version **v2.x.x** of the **CLI**.
15+
16+
The bug report form helps to streamline the process.
17+
Please fill out all required fields and choose a *minimal* reproducible example.
18+
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Describe the bug
23+
description: What did you try to do? What did not work? Anything else to be aware of?
24+
placeholder: "A clear and concise description of what the bug is."
25+
value: |
26+
A clear and concise description of what the bug is.
27+
28+
Also add any other context about the problem here.
29+
For example, what `--version` you are using.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: example_code_input
35+
attributes:
36+
label: HTML Input
37+
description: Please choose a minimal input that shows the problem. This will be automatically formatted into code, so no need for backticks.
38+
placeholder: "<h1>Title</h1>"
39+
render: html
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: example_code_actual
45+
attributes:
46+
label: Generated Markdown
47+
description: The *actual* output of the converter. This will be automatically formatted into code, so no need for backticks.
48+
placeholder: "# Title"
49+
render: markdown
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: example_code_expected
55+
attributes:
56+
label: Expected Markdown
57+
description: The *expected* output of the converter. This will be automatically formatted into code, so no need for backticks.
58+
placeholder: "# Title!!!"
59+
render: markdown
60+
validations:
61+
required: true
62+
63+
- type: dropdown
64+
id: operating_system
65+
attributes:
66+
label: Operating System
67+
description: On what operating system are you using the CLI?
68+
options:
69+
- MacOS
70+
- Linux
71+
- Windows
72+
validations:
73+
required: true
74+
75+
- type: markdown
76+
attributes:
77+
value: |
78+
----
79+
80+
Thanks for taking the time to fill out this bug report!
81+
82+
*We usually answer you in 2-3 days and then fix it on the weekend.*

‎.github/ISSUE_TEMPLATE/02-golang-v2-bug-report.yaml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
2+
name: 🐛 Golang V2 Bug Report
3+
description: File a bug report for the golang library v2.x.x
4+
5+
title: "[Bug]: Your title"
6+
labels: ["bug", "v2"]
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
### Thank you for contributing to the project!
13+
14+
You are creating a issue for the version **v2** of the **Golang** package.
15+
16+
The bug report form helps to streamline the process.
17+
Please fill out all required fields and choose a *minimal* reproducible example.
18+
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Describe the bug
23+
description: What did you try to do? What did not work? Anything else to be aware of?
24+
placeholder: "A clear and concise description of what the bug is."
25+
value: |
26+
A clear and concise description of what the bug is.
27+
28+
Also add any other context about the problem here.
29+
For example, if you changed the default options or used a plugin. Also adding the version from the `go.mod` is helpful.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: example_code_input
35+
attributes:
36+
label: HTML Input
37+
description: Please choose a minimal input that shows the problem. This will be automatically formatted into code, so no need for backticks.
38+
placeholder: "<h1>Title</h1>"
39+
render: html
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: example_code_actual
45+
attributes:
46+
label: Generated Markdown
47+
description: The *actual* output of the converter. This will be automatically formatted into code, so no need for backticks.
48+
placeholder: "# Title"
49+
render: markdown
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: example_code_expected
55+
attributes:
56+
label: Expected Markdown
57+
description: The *expected* output of the converter. This will be automatically formatted into code, so no need for backticks.
58+
placeholder: "# Title!!!"
59+
render: markdown
60+
validations:
61+
required: true
62+
63+
- type: dropdown
64+
id: plugins
65+
attributes:
66+
label: What plugins did you use?
67+
description: You can select multiple.
68+
multiple: true
69+
options:
70+
- base
71+
- commonmark
72+
- strikethrough
73+
- other plugin
74+
75+
- type: markdown
76+
attributes:
77+
value: |
78+
----
79+
80+
Thanks for taking the time to fill out this bug report!
81+
82+
*We usually answer you in 2-3 days and then fix it on the weekend.*

‎.github/ISSUE_TEMPLATE/03-golang-v1-bug-report.yaml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
2+
name: 🐛 Golang V1 Bug Report
3+
description: File a bug report for the golang library v1.x.x
4+
5+
title: "[Bug]: Your title"
6+
labels: ["bug", "v1"]
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
### Thank you for contributing to the project!
13+
14+
You are creating a issue for the version **v1** of the **Golang** package.
15+
16+
The bug report form helps to streamline the process.
17+
Please fill out all required fields and choose a *minimal* reproducible example.
18+
19+
> [!TIP]
20+
> There is a new v2 version of the library. Consider upgrading.
21+
22+
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Describe the bug
27+
description: What did you try to do? What did not work? Anything else to be aware of?
28+
placeholder: "A clear and concise description of what the bug is."
29+
value: |
30+
A clear and concise description of what the bug is.
31+
32+
Also add any other context about the problem here.
33+
For example, if you changed the default options or used a plugin. Also adding the version from the `go.mod` is helpful.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: example_code_input
39+
attributes:
40+
label: HTML Input
41+
description: Please choose a minimal input that shows the problem. This will be automatically formatted into code, so no need for backticks.
42+
placeholder: "<h1>Title</h1>"
43+
render: html
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: example_code_actual
49+
attributes:
50+
label: Generated Markdown
51+
description: The *actual* output of the converter. This will be automatically formatted into code, so no need for backticks.
52+
placeholder: "# Title"
53+
render: markdown
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: example_code_expected
59+
attributes:
60+
label: Expected Markdown
61+
description: The *expected* output of the converter. This will be automatically formatted into code, so no need for backticks.
62+
placeholder: "# Title!!!"
63+
render: markdown
64+
validations:
65+
required: true
66+
67+
- type: markdown
68+
attributes:
69+
value: |
70+
----
71+
72+
Thanks for taking the time to fill out this bug report!
73+
74+
*We usually answer you in 2-3 days and then fix it on the weekend.*

‎.github/ISSUE_TEMPLATE/04-feature-request.yaml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
name: ✨ Feature Request
3+
description: Request a new feature
4+
5+
title: "[Feature]: Your title"
6+
labels: ["enhancement"]
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
### Thank you for contributing to the project!
13+
14+
You want want to request a new feature? Great!
15+
16+
17+
- type: textarea
18+
id: description
19+
attributes:
20+
label: Describe the improvement
21+
description: What feature should be implemented? How are other libraries doing it?
22+
placeholder: "A clear and concise description of what improvement you wish for."
23+
validations:
24+
required: true
25+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)