From 204e76e70f6f5210b1c988b77ff4d9f66ccd998f Mon Sep 17 00:00:00 2001 From: jghagemann Date: Fri, 21 Mar 2025 12:56:50 -0300 Subject: [PATCH] improving form clarity --- .github/ISSUE_TEMPLATE/bug-report.yml | 100 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 60 +++++++++++++ 2 files changed, 160 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..4083272ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,100 @@ +name: Bug Report +description: Create a bug report +labels: ["type: bug"] +body: + + - type: markdown + attributes: + value: | + Thank you for contributing with Quarkus OpenAPI Generator with this bug report! Submit your issue below: + + - type: markdown + attributes: + value: | + ## Bug Report + + - type: dropdown + id: extension + attributes: + label: "Tell us the extension you're using" + multiple: false + options: + - Client + - Server + - Mock + validations: + required: true + + - type: textarea + id: i-tried-this + attributes: + label: "I tried this:" + placeholder: "What did you try to do? A code snippet or example helps." + validations: + required: true + + - type: textarea + id: instead-what-happened + attributes: + label: "This happened:" + placeholder: "What happened instead of what you've expected?" + validations: + required: true + + - type: textarea + id: what-did-you-expect + attributes: + label: "I expected this:" + placeholder: "What did you expect to happen? Describe the output or behavior you expected to see (unless it's obvious)." + + - type: textarea + id: workaround + attributes: + label: "Is there a workaround?" + placeholder: "What's the workaround to avoid this issue?" + + - type: textarea + id: reproduce + attributes: + label: "How can we try to reproduce the issue?" + placeholder: "What steps or configuration do we need to reproduce the erratic behavior?" + + - type: textarea + attributes: + label: Anything else? + placeholder: | + Links? References? Logs? Anything that will give us more context about the issue you are encountering. + Tip: You can attach images or log files by dragging files in. + + - type: markdown + attributes: + value: | + ## Environment + + - type: input + attributes: + label: Output of `uname -a` or `ver` + - type: input + attributes: + label: Output of `java -version` + - type: input + attributes: + label: Quarkus OpenApi version or git rev + - type: input + attributes: + label: Build tool (ie. output of `mvnw --version` or `gradlew --version`) + - type: textarea + attributes: + label: Additional information + description: > + If you have any additional information for us, please feel free to use the field below. + You can attach screenshots or screen recordings here, by + dragging and dropping files in the field below. + + - type: textarea + attributes: + label: Community Notes + value: | + + * Please vote by adding a 👍 reaction to the issue to help us prioritize. + * If you are interested to work on this issue, please leave a comment.name: Bug Report 🐞 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..5c965d0ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,60 @@ +name: Feature Request +description: Request a new feature +labels: ["type: feature"] +body: + + - type: markdown + attributes: + value: | + :pray: Thanks for taking the time to fill out this feature request! + + - type: markdown + attributes: + value: | + ## Feature Request + + - type: dropdown + id: extension + attributes: + label: "Tell us the extension to which you'd like to add the feature." + multiple: false + options: + - Client + - Server + - Mock + validations: + required: true + + - type: textarea + id: what-would-you-like-to-add + attributes: + label: "What kind of feature would you like to add?" + placeholder: "Description of the feature you'd like to see." + validations: + required: true + + - type: textarea + id: proposals + attributes: + label: "Proposal(s):" + placeholder: "Describe your proposal(s) and any relevant details here." + + - type: textarea + id: alternatives + attributes: + label: "Alternative(s):" + placeholder: "Describe any alternative approaches, options, or suggestions you’d like to consider." + + - type: textarea + id: additional-info + attributes: + label: "Additional info:" + placeholder: "Provide any supplementary details, context, or supporting information here." + + - type: textarea + attributes: + label: Community Notes + value: | + + * Please vote by adding a 👍 reaction to the feature to help us prioritize. + * If you want to work on this feature, please leave a comment. \ No newline at end of file