From 2b6cf1d0723bc1a5f4495285fa599b72244ad5ab Mon Sep 17 00:00:00 2001 From: Mohan Boddu Date: Tue, 29 Nov 2022 22:50:56 -0500 Subject: [PATCH] Update the issue templates Adding "Bug Report" and "Feature Request" templates, this will help with filing the tickets and also finding the information once filed. Signed-off-by: Mohan Boddu --- .github/ISSUE_TEMPLATE.md | 54 ----------- .github/ISSUE_TEMPLATE/bug_report.yaml | 101 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yaml | 41 ++++++++ CONTRIBUTING.md | 10 +- 5 files changed, 150 insertions(+), 57 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 33c1f8a901..b0e0d6776d 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,7 +3,6 @@ BUG REPORT INFORMATION --------------------------------------------------- Use the commands below to provide key information from your environment: -You do NOT have to include this information if this is a FEATURE REQUEST **NOTE** A large number of issues reported against Podman are often found to already be fixed in more current versions of the project. Before reporting an issue, please verify the @@ -20,56 +19,3 @@ against Buildah (https://github.com/containers/buildah/issues). Podman build executes Buildah to perform container builds, and as such the Buildah maintainers are best equipped to handle these bugs. --> - -**Is this a BUG REPORT or FEATURE REQUEST? (leave only one on its own line)** - -/kind bug - -/kind feature - -**Description** - - - -**Steps to reproduce the issue:** - -1. - -2. - -3. - -**Describe the results you received:** - - -**Describe the results you expected:** - - -**Additional information you deem important (e.g. issue happens only occasionally):** - -**Output of `podman version`:** - -``` -(paste your output here) -``` - -**Output of `podman info`:** - -``` -(paste your output here) -``` - -**Package info (e.g. output of `rpm -q podman` or `apt list podman` or `brew info podman`):** - -``` -(paste your output here) -``` - -**Have you tested with the latest version of Podman and have you checked [the Podman Troubleshooting Guide](https://github.com/containers/podman/blob/main/troubleshooting.md)?** - - -Yes/No - -**Additional environment details (AWS, VirtualBox, physical, etc.):** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..31195db4b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,101 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["kind/bug", "triage-needed"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + **NOTE** A large number of issues reported against Podman are often found to already be fixed in more current versions of the project. Before reporting an issue, please verify the version you are running with `podman version` and compare it to the latest release documented on the top of Podman's [README.md](../README.md). If they differ, please update your version of Podman to the latest possible and retry your command before creating an issue. + + Also, there is a running list of known issues in the [Podman Troubleshooting Guide](https://github.com/containers/podman/blob/main/troubleshooting.md), please reference that page before opening a new issue. + + Commands you might need to run to create the issue + $ podman version + $ podman info + $ rpm -q podman + - type: textarea + id: description + attributes: + label: Issue Description + description: Please explain your issue + value: "Describe your issue" + validations: + required: true + - type: textarea + id: reproducer + attributes: + label: Steps to reproduce the issue + description: Please explain the steps to reproduce the issue + value: "Steps to reproduce the issue\n1.\n2.\n3.\n" + validations: + required: true + - type: textarea + id: received_results + attributes: + label: Describe the results you received + description: Please explain the results you are noticing + value: "Describe the results you received" + validations: + required: true + - type: textarea + id: expected_results + attributes: + label: Describe the results you expected + description: Please explain the results you are expecting + value: "Describe the results you expected" + validations: + required: true + - type: textarea + id: podman_info + attributes: + label: podman info output + description: Please copy and paste podman info output. + value: If you are unable to run podman info for any reason, please provide the podman version, operating system and its version and the architecture you are running. + render: shell + validations: + required: true + - type: dropdown + id: podman_in_a_container + attributes: + label: Podman in a container + description: Please select Yes if you are running podman in a container + options: + - 'No' + - 'Yes' + validations: + required: true + - type: dropdown + id: privileged_rootless + attributes: + label: Privileged Or Rootless + description: Are you running the containers as privileged or non-root user? + options: + - Privileged + - Rootless + - type: dropdown + id: upstream_latest + attributes: + label: Upstream Latest Release + description: Have you tried running the [latest upstream release](https://github.com/containers/podman/releases/latest) + options: + - 'Yes' + - 'No' + validations: + required: true + - type: textarea + id: additional_environment + attributes: + label: Additional environment details + description: Please describe any additional environment details like (AWS, VirtualBox,...) + value: "Additional environment details" + - type: textarea + id: additional_info + attributes: + label: Additional information + description: Please explain the additional information you deem important + value: "Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..0086358db1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000000..20713b1ad5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,41 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature]: " +labels: ["kind/feature"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: feature_description + attributes: + label: Feature request description + description: Please explain your feature request and if it is related to a problem + value: "A clear and concise description of what the feature request is about." + validations: + required: true + - type: textarea + id: potential_solution + attributes: + label: Suggest potential solution + description: Please explain if you can suggest any potential solution + value: "A clear and concise description of what you want to happen." + validations: + required: false + - type: textarea + id: alternatives + attributes: + label: Have you considered any alternatives? + description: Please explain what alternatives you have tried. + value: "A clear and concise description of any alternative solutions or features you've considered." + validations: + required: false + - type: textarea + id: additional_context + attributes: + label: Additional context + description: Please add any context to this feature request + value: "Add any other context or screenshots about the feature request here." + validations: + required: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9945c39910..a85efe800d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,13 @@ your scenario, or additional information, to the discussion. Or simply If you find a new issue with the project we'd love to hear about it! The most important aspect of a bug report is that it includes enough information for -us to reproduce it. So, please include as much detail as possible and try -to remove the extra stuff that doesn't really relate to the issue itself. -The easier it is for us to reproduce it, the faster it'll be fixed! +us to reproduce it. To make this easier, there are three types of issue +templates you can use, if you have a bug to report, please use *Bug Report* +template or if you have an idea to propose, please use the *Feature Request* +template or if your issue is something else, please use the default template. +Please include as much detail as possible and try to remove the extra stuff +that doesn't really relate to the issue itself. The easier it is for us to +reproduce it, the faster it'll be fixed! Please don't include any private/sensitive information in your issue!