From b362cb771bd8b4c2a22adf08f48ed5dd8ad2680e Mon Sep 17 00:00:00 2001 From: joohyukkim Date: Sat, 19 Aug 2023 19:46:34 +0900 Subject: [PATCH] Make issue templates more consistent Initial draft Update feature_request.yaml Fix syntax error --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ----------- .github/ISSUE_TEMPLATE/bug_report.yaml | 61 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------- .github/ISSUE_TEMPLATE/feature_request.yaml | 35 ++++++++++++ .github/ISSUE_TEMPLATE/question.md | 11 ---- .github/ISSUE_TEMPLATE/question.yaml | 19 +++++++ 6 files changed, 115 insertions(+), 63 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 09a417c5..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'bug' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -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. - -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). - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Versions** -Kotlin: -Jackson-module-kotlin: -Jackson-databind: - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..4957ffa0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -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!" diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f903bbda..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'enhancement' -assignees: '' - ---- - -**Use case** -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. - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..3b50b352 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -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." diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 0b4decd0..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Question -about: Anything you're not sure about? Just ask us -title: '' -labels: 'question' -assignees: '' - ---- - -**Your question** -Before asking your question, please check out docs. diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 00000000..a6a71ca7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -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."