From 7f9e55dd458a6c60436d373cec97289bf580a5df Mon Sep 17 00:00:00 2001 From: anupama-pathirage Date: Mon, 21 Oct 2024 13:23:54 -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.yml | 57 --------------------- .github/ISSUE_TEMPLATE/type_improvement.yml | 53 ------------------- .github/ISSUE_TEMPLATE/type_new_feature.yml | 51 ------------------ .github/ISSUE_TEMPLATE/type_task.yml | 44 ---------------- 9 files changed, 115 insertions(+), 211 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.yml delete mode 100644 .github/ISSUE_TEMPLATE/type_improvement.yml delete mode 100644 .github/ISSUE_TEMPLATE/type_new_feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/type_task.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000000..1c1bfe3ff4 --- /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 5088d3fbb0..f325d56715 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 0000000000..053bfa803d --- /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 0000000000..39dd56f35e --- /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 0000000000..ff238a0ec7 --- /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.yml b/.github/ISSUE_TEMPLATE/type_bug.yml deleted file mode 100644 index 13c5ecb133..0000000000 --- a/.github/ISSUE_TEMPLATE/type_bug.yml +++ /dev/null @@ -1,57 +0,0 @@ -name: Bug Report -description: File a bug report -title: "[Bug]: " -labels: ["Type/Bug"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: textarea - id: description - attributes: - label: Description - description: Give a brief description of the bug - validations: - required: true - - type: textarea - id: reproducing-steps - attributes: - label: Steps to Reproduce - description: The steps to be followed to reproduce the issue. - validations: - required: false - - type: textarea - id: affected-area - attributes: - label: Affected Version(s) - description: The versions that are affected by the bug - validations: - required: false - - type: textarea - id: env-details - attributes: - label: OS, DB, other environment details and versions - validations: - required: false - - type: textarea - id: related-issues - attributes: - label: Related issue(s) (optional) - description: Any related issues such as sub tasks and issues reported in other repositories (e.g., component repositories), similar problems, etc. - validations: - required: false - - type: textarea - id: suggested-labels - attributes: - label: Suggested label(s) (optional) - description: Optional comma-separated list of suggested labels. Non committers can’t assign labels to issues, and thereby, this will help issue creators who are not a committer to suggest possible labels. - validations: - required: false - - type: textarea - id: suggested-assignees - attributes: - label: Suggested assignee(s) (optional) - description: Optional comma-separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, and thereby, this will help issue creators who are not a committer to suggest possible assignees. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/type_improvement.yml b/.github/ISSUE_TEMPLATE/type_improvement.yml deleted file mode 100644 index 4c127030ca..0000000000 --- a/.github/ISSUE_TEMPLATE/type_improvement.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Improvement Request -description: File a improvement request -title: "[Improvement]: " -labels: ["Type/Improvement"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this improvement request! - - type: textarea - id: description - attributes: - label: Description - description: Give a brief description of the improvement - validations: - required: true - - type: textarea - id: problem-description - attributes: - label: Describe your problem(s) - description: Detailed description on the problem. - validations: - required: false - - type: textarea - id: solution-description - attributes: - label: Describe your solution(s) - description: Detailed description on the solution - validations: - required: false - validations: - required: true - - type: textarea - id: related-issues - attributes: - label: Related issue(s) (optional) - description: Any related issues such as sub tasks and issues reported in other repositories (e.g., component repositories), similar problems, etc. - validations: - required: false - - type: textarea - id: suggested-labels - attributes: - label: Suggested label(s) (optional) - description: Optional comma-separated list of suggested labels. Non committers can’t assign labels to issues, and thereby, this will help issue creators who are not a committer to suggest possible labels. - validations: - required: false - - type: textarea - id: suggested-assignees - attributes: - label: Suggested assignee(s) (optional) - description: Optional comma-separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, and thereby, this will help issue creators who are not a committer to suggest possible assignees. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/type_new_feature.yml b/.github/ISSUE_TEMPLATE/type_new_feature.yml deleted file mode 100644 index a3d5bb3786..0000000000 --- a/.github/ISSUE_TEMPLATE/type_new_feature.yml +++ /dev/null @@ -1,51 +0,0 @@ -name: New Feature Request -description: File a new feature request -title: "[New Feature]: " -labels: ["Type/NewFeature"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this new feature request! - - type: textarea - id: description - attributes: - label: Description - description: Give a brief description of the feature - validations: - required: true - - type: textarea - id: feature-description - attributes: - label: Describe your problem(s) - description: Detailed description on the problem. - validations: - required: false - - type: textarea - id: solution-description - attributes: - label: Describe your solution(s) - description: Detailed description on the solution - validations: - required: false - - type: textarea - id: related-issues - attributes: - label: Related issue(s) (optional) - description: Any related issues such as sub tasks and issues reported in other repositories (e.g., component repositories), similar problems, etc. - validations: - required: false - - type: textarea - id: suggested-labels - attributes: - label: Suggested label(s) (optional) - description: Optional comma-separated list of suggested labels. Non committers can’t assign labels to issues, and thereby, this will help issue creators who are not a committer to suggest possible labels. - validations: - required: false - - type: textarea - id: suggested-assignees - attributes: - label: Suggested assignee(s) (optional) - description: Optional comma-separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, and thereby, this will help issue creators who are not a committer to suggest possible assignees. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/type_task.yml b/.github/ISSUE_TEMPLATE/type_task.yml deleted file mode 100644 index a3a37dc947..0000000000 --- a/.github/ISSUE_TEMPLATE/type_task.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Task Request -description: File a task request -title: "[Task]: " -labels: ["Type/Task"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this task form! - - type: textarea - id: description - attributes: - label: Description - description: Give a brief description of the task - validations: - required: true - - type: textarea - id: task-description - attributes: - label: Describe your task(s) - description: Detailed description on the task. - validations: - required: false - - type: textarea - id: related-issues - attributes: - label: Related issue(s) (optional) - description: Any related issues such as sub tasks and issues reported in other repositories (e.g., component repositories), similar problems, etc. - validations: - required: false - - type: textarea - id: suggested-labels - attributes: - label: Suggested label(s) (optional) - description: Optional comma-separated list of suggested labels. Non committers can’t assign labels to issues, and thereby, this will help issue creators who are not a committer to suggest possible labels. - validations: - required: false - - type: textarea - id: suggested-assignees - attributes: - label: Suggested assignee(s) (optional) - description: Optional comma-separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, and thereby, this will help issue creators who are not a committer to suggest possible assignees. - validations: - required: false