Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the issue templates #16572

Merged
merged 1 commit into from
Jan 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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**

<!--
Briefly describe the problem you are having in a few paragraphs.
-->

**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.):**
101 changes: 101 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -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!
Comment on lines +8 to +9
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the current template, this is all inside HTML comments. That minimizes clutter. Does this "attributes" thing also guarantee that the new template will have this cruft in comments?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, its all part of HTML page rather than part of the form


**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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE, this link does not actually point to the latest release following semver. It chooses the latest release by date so it could link to outdated versions when we do backport releases.

Copy link
Author

@mohanboddu mohanboddu Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use https://github.blog/changelog/2022-10-21-explicitly-set-the-latest-release/ to mark the latest release, might require some work from @mheon based on how he is cutting the release and if it is useful in general.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#16696 should solve this issue as well

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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -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
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down