From a10768b271e487a0158bcb550fdff8ff926ceb97 Mon Sep 17 00:00:00 2001 From: Tamal Das Date: Wed, 21 Feb 2024 20:07:36 +0530 Subject: [PATCH] feat: upgrades to issue templates (#217) Co-authored-by: Khuda Dad Nomani <32505158+KhudaDad414@users.noreply.github.com>%0ACo-authored-by: Alejandra Quetzalli %0ACo-authored-by: Lukasz Gornicki --- .github/ISSUE_TEMPLATE/bug.md | 18 ------ .github/ISSUE_TEMPLATE/bug.yml | 83 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.md | 18 ------ .github/ISSUE_TEMPLATE/enhancement.yml | 70 ++++++++++++++++++++++ 4 files changed, 153 insertions(+), 36 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 665a150b..00000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Bug report -about: Report a bug so we can fix and improve -labels: bug ---- - -#### Describe the bug -A clear and concise description of what the bug is. - -#### How to Reproduce -Steps to reproduce the issue. Attach all resources that can help us understand the issue: - -- Screenshots -- Link to GitHub repository with project that has issues -- Files that can help reproduce the issue, like your AsyncAPI file, either paste inside the issue in a code block or in a sharable [gist](https://gist.github.com/) - -#### Expected behavior -A clear and concise description of what you expected to happen. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..0334900f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,83 @@ +name: 🐛 Bug Report +description: Report bugs to fix and improve. +title: "[BUG] " +labels: ["bug"] + + +body: + - type: textarea + id: description + attributes: + label: Describe the bug. + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots/video of the bug you faced. + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: How to Reproduce + description: Attach all steps/share a github gist that can help anyone reproduce the bug. + value: | + 1. I first did this + 2. I then did this + 3. And so on . . . + validations: + required: true + + - type: dropdown + id: browser + attributes: + label: "🥦 Browser" + description: "What browser are you using?" + options: + - Google Chrome + - Brave + - Microsoft Edge + - Mozilla Firefox + - Safari + - Opera + - Other + validations: + required: optional + + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you checked for similar open issues?" + options: + - label: "I checked and didn't find similar issue" + required: true + + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "🏢 Have you read the Contributing Guidelines?" + options: + - label: "I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)" + required: true + + - type: dropdown + attributes: + label: Are you willing to work on this issue ? + description: This is absolutely not required, but we are happy to guide you in the contribution process. + options: + - "Yes I am willing to submit a PR!" + - "No, someone else can work on it" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 92cbf241..00000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Feature request -about: Suggest how we can improve -labels: enhancement ---- - -#### Reason/Context -Please try answering few of those questions -- Why we need this improvement? -- How will this change help? -- What is the motivation? - - -#### Description -Please try answering few of those questions -- What changes have to be introduced? -- Will this be a breaking change? -- How could it be implemented/designed? diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 00000000..255b6d92 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,70 @@ +name: 💡 Feature Request +description: Suggest a new idea/feature +title: "[FEATURE] " +labels: ["enhancement"] + +body: + - type: textarea + id: need_improvement + attributes: + label: Why do we need this improvement? + validations: + required: true + + - type: textarea + id: change + attributes: + label: How will this change help? + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + + + - type: textarea + id: implemented + attributes: + label: How could it be implemented/designed? + validations: + required: true + + - type: dropdown + id: breakingchange + attributes: + label: "🚧 Breaking changes" + description: "Will this be a breaking change?" + options: + - "Yes" + - "No" + validations: + required: true + + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you checked for similar open issues?" + options: + - label: "I checked and didn't find a similar issue" + required: true + + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "🏢 Have you read the Contributing Guidelines?" + options: + - label: "I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)" + required: true + + - type: dropdown + attributes: + label: Are you willing to work on this issue? + description: This is absolutely not required, but we are happy to guide you in the contribution process. + options: + - "Yes I am willing to submit a PR!" + - "No, someone else can work on it." \ No newline at end of file