Skip to content

Commit

Permalink
Introduce more efficient Form-Based GitHub Issue Templates (#4042)
Browse files Browse the repository at this point in the history
  • Loading branch information
JooHyukKim authored Jul 15, 2023
1 parent a67a72b commit dc19ee8
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 68 deletions.
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug report
description: If you find something that does not work the way it should
labels: [ "to-evaluate" ]
body:
- type: checkboxes
id: pre-check
attributes:
label: Search before asking
description: "Please search [issues](https://github.com/FasterXML/jackson-databind/issues) to check if your issue has already been reported."
options:
- label: "I searched in the [issues](https://github.com/FasterXML/jackson-databind/issues) and found nothing similar."
required: true
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: "A clear and concise description of what the bug is."
validations:
required: true
- type: textarea
id: version-info
attributes:
label: Version Information
description: "Which Jackson version(s) was this for?"
placeholder: |
ex) 2.15.2
validations:
required: false
- type: textarea
id: reproduce
attributes:
label: Reproduction
description: "If you have a way to reproduce this with:"
value: |
<-- Any of the following
1. Brief code sample/snippet: include here in preformatted/code section
2. Longer example stored somewhere else (diff repo, snippet), add a link
3. Textual explanation: include here
-->
```java
// Your code here
```
validations:
required: false
- type: textarea
id: expected
attributes:
label: Expected behavior
description: "If reproduction itself needs further explanation, you may also add more details here."
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: "Add any other context about the problem here."
- type: markdown
attributes:
value: "Thanks for reporting the bug!"
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/documentation_request.md

This file was deleted.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Documentation request
description: If you have a great idea of how to improve documentation
labels: [ "to-evaluate" ]
body:
- type: textarea
id: documentation-improvement
attributes:
label: Documentation Improvement
description: "Which part of documentation is missing, incorrect, or out of date? Please describe. You may suggest changes, deletions, additions."
validations:
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature request
description: Suggest an improvement to an existing feature, or propose a new one
labels: [ "to-evaluate" ]
body:
- type: textarea
id: problem-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
validations:
required: true
- type: textarea
id: desired-solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen
validations:
required: true
- type: textarea
id: usage-example
attributes:
label: Usage example
description: If you have a clear idea of how to use proposed new/modified feature, please show an example.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the feature request here.
validations:
required: false
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/something_else.md

This file was deleted.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/something_else.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Something Else
description: If none of the other options is a match, please use this template
labels: [ "to-evaluate" ]
body:
- type: textarea
id: something-else
attributes:
label: Describe your Issue
description: "Please provide a clear and concise description of what the issue is."
validations:
required: true

0 comments on commit dc19ee8

Please sign in to comment.