From 09caecbf1f1357e574053230ea549a021aafb196 Mon Sep 17 00:00:00 2001 From: anupama-pathirage Date: Mon, 21 Oct 2024 13:40:50 -0500 Subject: [PATCH] Add new issue template --- .github/ISSUE_TEMPLATE/bug.yml | 31 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 15 ++++++---- .github/ISSUE_TEMPLATE/improvement.yml | 25 +++++++++++++++++ .github/ISSUE_TEMPLATE/new-feature.yml | 32 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/task.yml | 18 ++++++++++++ .github/ISSUE_TEMPLATE/type_bug.md | 24 ---------------- .github/ISSUE_TEMPLATE/type_improvement.md | 22 --------------- .github/ISSUE_TEMPLATE/type_new_feature.md | 22 --------------- .github/ISSUE_TEMPLATE/type_task.md | 20 -------------- 9 files changed, 115 insertions(+), 94 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/improvement.yml create mode 100644 .github/ISSUE_TEMPLATE/new-feature.yml create mode 100644 .github/ISSUE_TEMPLATE/task.yml delete mode 100644 .github/ISSUE_TEMPLATE/type_bug.md delete mode 100644 .github/ISSUE_TEMPLATE/type_improvement.md delete mode 100644 .github/ISSUE_TEMPLATE/type_new_feature.md delete mode 100644 .github/ISSUE_TEMPLATE/type_task.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..1c1bfe3ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,31 @@ +name: "🐞 Report a Bug" +description: Create an issue if something does not work as expected. +labels: ["Type/Bug"] +body: + - type: textarea + id: background + attributes: + label: Description + description: Please share a clear and concise description of the problem. + placeholder: Description + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: List the steps you followed when you encountered the issue. Provide sample source code to reproduce the issue where applicable. + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: Enter product/component version. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment Details (with versions) + description: Mention the environment details (OS, Client, etc.) that the product is running on. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5088d3fbb..f325d5671 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,11 @@ blank_issues_enabled: false contact_links: - - name: General Question - url: https://stackoverflow.com/questions/tagged/wso2-micro-integrator - about: "If you have a question then please ask on Stack Overflow using the #wso2-micro-integrator tag." - - name: Chat on help-micro-integrator Discord Channel - url: https://discord.com/invite/Xa5VubmThw - about: "Chat about anything else with the community." +- name: '📚 Documentation Issue' + about: Request a new article, missing topic, or report an issue if a topic is incorrect in the current documentation. + url: https://github.com/wso2/docs-mi/issues/new/choose +- name: General Question + url: https://stackoverflow.com/questions/tagged/wso2-micro-integrator + about: "If you have a question then please ask on Stack Overflow using the #wso2-micro-integrator tag." +- name: Chat on help-micro-integrator Discord Channel + url: https://discord.com/invite/Xa5VubmThw + about: "Chat about anything else with the community." diff --git a/.github/ISSUE_TEMPLATE/improvement.yml b/.github/ISSUE_TEMPLATE/improvement.yml new file mode 100644 index 000000000..053bfa803 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement.yml @@ -0,0 +1,25 @@ +name: "🚀 Improvement Request" +description: Suggest an improvement to the product. +labels: ["Type/Improvement"] +body: + - type: textarea + id: limitation + attributes: + label: Current Limitation + description: Describe the the current limitation. + validations: + required: true + - type: textarea + id: suggestion + attributes: + label: Suggested Improvement + description: Describe the the improvement you suggest. + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: Enter component version. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/new-feature.yml b/.github/ISSUE_TEMPLATE/new-feature.yml new file mode 100644 index 000000000..39dd56f35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -0,0 +1,32 @@ +name: "💡 New Feature Request" +description: Suggest new functionality and features for the product. +labels: ["Type/NewFeature"] +body: + - type: textarea + id: problem + attributes: + label: Problem + description: What is the problem this feature will solve? + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to have. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Describe any alternatives have you considered + validations: + required: false + - type: input + id: version + attributes: + label: Version + description: Enter product/component version. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 000000000..ff238a0ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,18 @@ +name: "✍️ Create a Task" +description: Create a new task. +labels: ["Type/Task"] +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear description of what needs to be done. + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: Enter product/component version. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/type_bug.md b/.github/ISSUE_TEMPLATE/type_bug.md deleted file mode 100644 index b14deabca..000000000 --- a/.github/ISSUE_TEMPLATE/type_bug.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: "Bug Report" -about: "Report a bug if something is not working as expected" -labels: 'Type/Bug' - ---- - -**Description:** - - -**Steps to reproduce:** - -**Affected Versions:** - -**OS, DB, other environment details and versions:** - -**Related Issues (optional):** - - -**Suggested Labels (optional):** - - -**Suggested Assignees (optional):** - diff --git a/.github/ISSUE_TEMPLATE/type_improvement.md b/.github/ISSUE_TEMPLATE/type_improvement.md deleted file mode 100644 index c7af3704e..000000000 --- a/.github/ISSUE_TEMPLATE/type_improvement.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: "Improvement Request" -about: "Create an improvement request for an existing feature" -labels: 'Type/Improvement' - ---- - -**Description:** - - -**Describe your problem(s)** - -**Describe your solution(s)** - -**Related Issues (optional):** - - -**Suggested Labels (optional):** - - -**Suggested Assignees (optional):** - diff --git a/.github/ISSUE_TEMPLATE/type_new_feature.md b/.github/ISSUE_TEMPLATE/type_new_feature.md deleted file mode 100644 index 72c00dfc4..000000000 --- a/.github/ISSUE_TEMPLATE/type_new_feature.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: "New Feature Request" -about: "Create a new feature request" -labels: 'Type/NewFeature' - ---- - -**Description:** - - -**Describe your problem(s)** - -**Describe your solution(s)** - -**Related Issues (optional):** - - -**Suggested Labels (optional):** - - -**Suggested Assignees (optional):** - diff --git a/.github/ISSUE_TEMPLATE/type_task.md b/.github/ISSUE_TEMPLATE/type_task.md deleted file mode 100644 index 2cc8fbedb..000000000 --- a/.github/ISSUE_TEMPLATE/type_task.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "Task" -about: "Create a task which you want to keep track" -labels: 'Type/Task' - ---- - -**Description:** - - -**Describe your task(s)** - -**Related Issues (optional):** - - -**Suggested Labels (optional):** - - -**Suggested Assignees (optional):** -