Skip to content

Commit dc19ee8

Browse files
authored
Introduce more efficient Form-Based GitHub Issue Templates (#4042)
1 parent a67a72b commit dc19ee8

File tree

8 files changed

+113
-68
lines changed

8 files changed

+113
-68
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Bug report
2+
description: If you find something that does not work the way it should
3+
labels: [ "to-evaluate" ]
4+
body:
5+
- type: checkboxes
6+
id: pre-check
7+
attributes:
8+
label: Search before asking
9+
description: "Please search [issues](https://github.com/FasterXML/jackson-databind/issues) to check if your issue has already been reported."
10+
options:
11+
- label: "I searched in the [issues](https://github.com/FasterXML/jackson-databind/issues) and found nothing similar."
12+
required: true
13+
- type: textarea
14+
id: bug-description
15+
attributes:
16+
label: Describe the bug
17+
description: "A clear and concise description of what the bug is."
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: version-info
22+
attributes:
23+
label: Version Information
24+
description: "Which Jackson version(s) was this for?"
25+
placeholder: |
26+
ex) 2.15.2
27+
validations:
28+
required: false
29+
- type: textarea
30+
id: reproduce
31+
attributes:
32+
label: Reproduction
33+
description: "If you have a way to reproduce this with:"
34+
value: |
35+
<-- Any of the following
36+
1. Brief code sample/snippet: include here in preformatted/code section
37+
2. Longer example stored somewhere else (diff repo, snippet), add a link
38+
3. Textual explanation: include here
39+
-->
40+
```java
41+
// Your code here
42+
```
43+
validations:
44+
required: false
45+
- type: textarea
46+
id: expected
47+
attributes:
48+
label: Expected behavior
49+
description: "If reproduction itself needs further explanation, you may also add more details here."
50+
validations:
51+
required: false
52+
- type: textarea
53+
id: context
54+
attributes:
55+
label: Additional context
56+
description: "Add any other context about the problem here."
57+
- type: markdown
58+
attributes:
59+
value: "Thanks for reporting the bug!"

.github/ISSUE_TEMPLATE/documentation_request.md

Lines changed: 0 additions & 11 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Documentation request
2+
description: If you have a great idea of how to improve documentation
3+
labels: [ "to-evaluate" ]
4+
body:
5+
- type: textarea
6+
id: documentation-improvement
7+
attributes:
8+
label: Documentation Improvement
9+
description: "Which part of documentation is missing, incorrect, or out of date? Please describe. You may suggest changes, deletions, additions."
10+
validations:
11+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature request
2+
description: Suggest an improvement to an existing feature, or propose a new one
3+
labels: [ "to-evaluate" ]
4+
body:
5+
- type: textarea
6+
id: problem-description
7+
attributes:
8+
label: Is your feature request related to a problem? Please describe.
9+
description: A clear and concise description of what the problem is.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: desired-solution
14+
attributes:
15+
label: Describe the solution you'd like
16+
description: A clear and concise description of what you want to happen
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: usage-example
21+
attributes:
22+
label: Usage example
23+
description: If you have a clear idea of how to use proposed new/modified feature, please show an example.
24+
validations:
25+
required: false
26+
- type: textarea
27+
id: additional-context
28+
attributes:
29+
label: Additional context
30+
description: Add any other context about the feature request here.
31+
validations:
32+
required: false

.github/ISSUE_TEMPLATE/something_else.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Something Else
2+
description: If none of the other options is a match, please use this template
3+
labels: [ "to-evaluate" ]
4+
body:
5+
- type: textarea
6+
id: something-else
7+
attributes:
8+
label: Describe your Issue
9+
description: "Please provide a clear and concise description of what the issue is."
10+
validations:
11+
required: true

0 commit comments

Comments
 (0)