From 785a41914346936e5af016958c30456cfb0f0d88 Mon Sep 17 00:00:00 2001 From: Mahmoud Mazouz Date: Tue, 30 Jan 2024 16:07:14 +0100 Subject: [PATCH] fix: Update issue templates --- .../ISSUE_TEMPLATE/bug_report.yml | 37 +++++++++++++++++++ .../ISSUE_TEMPLATE/ISSUE_TEMPLATE/config.yml | 5 +++ .../ISSUE_TEMPLATE/new_feature.yml | 27 ++++++++++++++ .../ISSUE_TEMPLATE/ISSUE_TEMPLATE/release.yml | 29 +++++++++++++++ 4 files changed, 98 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/new_feature.yml create mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/release.yml diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..fb2bbc23 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,37 @@ +name: Bug +description: | + Report a bug. +labels: ["bug"] +body: + - type: textarea + id: summary + attributes: + label: "Describe the bug" + description: | + A clear and concise description of the expected behaviour and what the bug is. + placeholder: | + E.g. zenoh peers can not automatically establish a connection. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To reproduce + description: "Steps to reproduce the behavior:" + placeholder: | + 1. Start a subscriber "..." + 2. Start a publisher "...." + 3. See error + validations: + required: true + - type: textarea + id: system + attributes: + label: System info + description: "Please complete the following information:" + placeholder: | + - Platform: [e.g. Ubuntu 20.04 64-bit] + - CPU [e.g. AMD Ryzen 3800X] + - Zenoh version/commit [e.g. 6f172ea985d42d20d423a192a2d0d46bb0ce0d11] + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0c05a054 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/eclipse-zenoh/roadmap/discussions/categories/zenoh + about: Open to the Zenoh community. Share your feedback with the Zenoh team. diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/new_feature.yml b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/new_feature.yml new file mode 100644 index 00000000..3990ea6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/new_feature.yml @@ -0,0 +1,27 @@ +name: New feature +description: | + Suggest a new feature. +labels: ["new feature"] +body: + - type: markdown + attributes: + value: | + **Guidelines for a good issue** + + *Is your feature request related to a problem?* + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + + *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 about the feature request here. + - type: textarea + id: feature + attributes: + label: "Describe the feature" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/release.yml b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/release.yml new file mode 100644 index 00000000..127a4ba8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE/release.yml @@ -0,0 +1,29 @@ +name: Add an issue to the next release +description: | + Add an issue as part of next release. + This will be added to the current release project. + You must be a contributor to use this template. +labels: ["release"] +body: + - type: markdown + attributes: + value: | + **Guidelines for a good issue** + + *Is your release item related to a problem?* + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + + *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 about the release item request here. + - type: textarea + id: item + attributes: + label: "Describe the release item" + validations: + required: true