Skip to content

Commit

Permalink
Make issue templates more consistent
Browse files Browse the repository at this point in the history
Initial draft

Update feature_request.yaml

Fix syntax error
  • Loading branch information
JooHyukKim committed Aug 19, 2023
1 parent dad40ec commit b362cb7
Show file tree
Hide file tree
Showing 6 changed files with 115 additions and 63 deletions.
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug report
description: Create a report to help us improve
labels: [ "bug" ]
assignees: [ ]

body:
- type: checkboxes
id: pre-check
attributes:
label: Search before asking
description: "Please search [issues](https://github.com/FasterXML/jackson-module-kotlin/issues) to check if your issue has already been reported."
options:
- label: "I searched in the [issues](https://github.com/FasterXML/jackson-module-kotlin/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: reproduce
attributes:
label: To Reproduce
description: "Test case or steps to reproduce the behavior. It would be appreciated if you could provide code that can be executed with as few changes as possible, such as include 'import' statements."
value: |
```kotlin
// Your code here
```
validations:
required: false
- type: markdown
attributes:
value: "Also, it would be appreciated if you could confirm in advance that the problem is reproduced only when using `Kotlin` or `kotlin-module`. For issues that are reproduced only in `Java`, please submit them to the appropriate repository, such as [FasterXML/jackson-databind](https://github.com/FasterXML/jackson-databind)."
- type: textarea
id: expected
attributes:
label: Expected behavior
description: "A clear and concise description of what you expected to happen."
validations:
required: false
- type: textarea
id: version-info
attributes:
label: Versions
description: "Please provide the versions you are using:"
value: |
Kotlin:
Jackson-module-kotlin:
Jackson-databind:
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!"
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature request
description: Suggest an idea for this project
labels: [ "enhancement" ]
assignees: [ ]

body:
- type: textarea
id: use-case
attributes:
label: Use case
description: "A clear and concise description of what the use-case is. This will better help us understand the context in which you're looking for a new feature."
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: alternatives
attributes:
label: Describe alternatives you've considered
description: "A clear and concise description of any alternative solutions or features you've considered."
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: "Add any other context or screenshots about the feature request here."
- type: markdown
attributes:
value: "Thanks for suggesting a feature! We appreciate your feedback and will consider it for future enhancements."
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Question
description: Anything you're not sure about? Just ask us
labels: [ "question" ]
assignees: [ ]

body:
- type: markdown
attributes:
value: "Before asking your question, please check out the docs."
- type: textarea
id: user-question
attributes:
label: Your question
placeholder: "What would you like to know?"
validations:
required: true
- type: markdown
attributes:
value: "Thanks for reaching out! We'll do our best to help."

0 comments on commit b362cb7

Please sign in to comment.