|
| 1 | +# Issue reporting on Podman |
| 2 | + |
| 3 | +The Podman team cares for our users and our communities. When someone has a problem with |
| 4 | +Podman and takes the time to report an [issue](https://github.com/containers/podman/issues) |
| 5 | +on our Github, we deeply appreciate the effort. We want to help. Consider reading |
| 6 | +our [support](SUPPORT.md) document prior to submitting an issue as well. |
| 7 | + |
| 8 | +## Considerations when reporting an issue upstream |
| 9 | + |
| 10 | +### Where to report your issue |
| 11 | + |
| 12 | +If you are running Podman acquired from a Linux distribution and that Linux distribution has a |
| 13 | +bug reporting mechanism, then please report the bug there. To report an issue on our |
| 14 | +github repository, use the issue tab and click [New Issue](https://github.com/containers/podman/issues/new/choose) |
| 15 | + |
| 16 | +### Development or latest version |
| 17 | + |
| 18 | +We view this Github repository as an upstream repository for development of the latest |
| 19 | +of Podman in the main branch. |
| 20 | + |
| 21 | +When reporting an issue, it should ideally be for the main branch of our repository. Please make |
| 22 | +an effort to reproduce the issue using the main branch whenever possible. An issue can also |
| 23 | +be written against the latest released version of Podman. |
| 24 | + |
| 25 | +The term "latest version" refers to our mainline development tree or the |
| 26 | +[latest release](https://github.com/containers/podman/releases/latest). |
| 27 | + |
| 28 | +### Bugs vs features |
| 29 | + |
| 30 | +A bug is when something in Podman is not working as it should or has been described. A |
| 31 | +feature or enhancement is when you would like Podman to behave differently. |
| 32 | + |
| 33 | +### Use the issue template when reporting bugs |
| 34 | +When you report an issue on the upstream repository, be sure to fill out the entire template. |
| 35 | +You must provide the required `podman info` wherever possible as it helps us diagnose |
| 36 | +your report. If possible, always provide a _reliable reproducer_. This is extremely |
| 37 | +helpful for us during triage and bug fixing. Good examples of a reliable repoducer are: |
| 38 | + |
| 39 | +* Provide precise Podman commands |
| 40 | +* Use generic images (like fedora/alpine/debian) where possible to reduce the chance your |
| 41 | +container images was a contributor. Abstracting away from the functional purpose helps |
| 42 | +diagnoses and reduces noise for us. |
| 43 | +* If using the RESTFUL API, providing curl commands as a repoducer is preferred. Be sure |
| 44 | +to provide the same data (or sample data) for things like POST. |
| 45 | +* Not requiring the use of a third party tool to reproduce the problem |
| 46 | + |
| 47 | + |
| 48 | +### Look through existing issues before reporting a new issue |
| 49 | +Managing issues is a time consuming processes for maintainers. You can save us time by |
| 50 | +making sure the issue you want to report has not already been reported. It is appropriate |
| 51 | +to comment on the existing issue with relevant information. |
| 52 | + |
| 53 | + |
| 54 | +### Why was my issue report closed |
| 55 | + |
| 56 | +Issues filed upstream may be closed by a maintainer for the following reasons: |
| 57 | + |
| 58 | +* A fix for the issue has been merged into the main branch of our upstream |
| 59 | +repository. It is possible that the bug was already fixed upstream as well. |
| 60 | +* The reported issue is a duplicate. |
| 61 | +* The issue is reported against a [distribution that has a bug reporting mechanism](#where-to-report-your-issue) |
| 62 | +or paid support. |
| 63 | +* The issue was reported using an [older version](#development-or-latest-version) of Podman. |
| 64 | +* A maintainer determines the code is working as designed. |
| 65 | +* The issue has become [stale](#-stale) and reporters are not responding. |
| 66 | +* We were unable to reproduce the issue, or there was insufficient information to reproduce the issue. |
| 67 | +* One or more maintainers have decided a feature will not be implemented or an issue will not be fixed. |
| 68 | + |
| 69 | + |
| 70 | +#### Definitions |
| 71 | + |
| 72 | +[**stale**](https://github.com/containers/podman/issues?q=is%3Aopen+is%3Aissue+sort%3Acreated-asc+label%3Astale-issue): open, but no activity in the last thirty days. |
| 73 | + |
| 74 | +**crickets**: closed due to lack of response from reporting party. |
| 75 | + |
| 76 | +[**jetsam**](https://github.com/containers/podman/issues?q=is%3Aissue+label%3Ajetsam+is%3Aclosed): closed without being implemented. A deliberate decision made in recognition of human limitations. |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | +#### Process |
| 81 | + |
| 82 | +In order of judgment, from least to most. |
| 83 | + |
| 84 | +##### → stale |
| 85 | + |
| 86 | +Issues are marked with the label *stale-issue* by a [github action](https://github.com/containers/podman/blob/main/.github/workflows/stale.yml) that runs daily at 00:00 UT. This also triggers an email alert to subscribers on that issue. |
| 87 | + |
| 88 | +Judgment: typically a team member will skim the issue, then decide whether to: |
| 89 | + |
| 90 | +* remove the label; or |
| 91 | +* close the issue (see below); or |
| 92 | +* do nothing. |
| 93 | + |
| 94 | +This is informal: there is no guarantee that anyone will actually do this. |
| 95 | + |
| 96 | +##### → crickets |
| 97 | + |
| 98 | +Typically done by a team member after receiving a *stale-issue* email. |
| 99 | + |
| 100 | +Judgment: |
| 101 | + |
| 102 | +* there is not enough information to act on the issue; and |
| 103 | +* someone on the team has asked the reporter for more details (like NEEDINFO); and |
| 104 | +* the reporter has not responded. |
| 105 | + |
| 106 | +There is no actual *crickets* label. There is no automated way to |
| 107 | +find issues that have been closed for this reason. |
| 108 | + |
| 109 | +##### → jetsam |
| 110 | + |
| 111 | +Last-resort closing of an issue that will not be worked on. |
| 112 | + |
| 113 | +Factors: |
| 114 | + |
| 115 | +* issue has remained open for over sixty days; and |
| 116 | +* reporter is responsive, and still wishes to have the issue addressed (as does the team). |
| 117 | + |
| 118 | +Judgment: |
| 119 | + |
| 120 | +* the issue is too difficult or complicated or hard to track down. |
| 121 | +* decision should be made by two or more team members, with discussion in the issue/PR itself. |
| 122 | + |
| 123 | +When such an issue is closed, team member should apply the *jetsam* label. |
![openshift-merge-bot[bot]](https://avatars.githubusercontent.com/in/412865?v=4&size=40){kind=avatar}
0 commit comments