Skip to content

Commit af7c6f8

Browse files
Merge pull request #25742 from mohanboddu/triage
Add documentation describing how to triage issues
2 parents dced2bf + 72acbc8 commit af7c6f8

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ If they do not respond after several days, you can notify a maintainer to have t
4747
When working on an issue, please assign it to yourself.
4848
You can use the `/assign` bot command in a comment on an issue to assign it to yourself.
4949
If you lack permissions to do so, you can ping the `@containers/podman-maintainers` group to have a maintainer set you as assignee.
50+
If you are a maintainer of Podman project, please following the [instructions](https://github.com/containers/podman/blob/main/TRIAGE.md) to triage new issues.
5051

5152
## Contributing to Podman
5253

@@ -324,6 +325,10 @@ Use your real name (sorry, no pseudonyms or anonymous contributions).
324325

325326
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.
326327

328+
### Reviewing PRs
329+
330+
If you are a maintainer of Podman project, please following the [guidelines](https://github.com/containers/podman/blob/main/REVIEWING.md) on how to review a PR.
331+
327332
### Continuous Integration
328333

329334
All pull requests automatically run Podman's test suite.

TRIAGE.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Triaging of Podman issues
2+
To manage new GitHub issues, maintainers perform issue triage on a regular basis and categorize the issues based on priority, type of issue, and other factors.
3+
4+
This process includes:
5+
1. Ensure the issue is relevant to the correct repository (i.e. build issues go to buildah repo, podman desktop issues go to Podman Desktop repo, etc) and transfer as needed.
6+
2. Categorize issues by type and assign its associated label ([see below](#labels)) and “traiged” label. If the issue is a bug and it is of high impact, please assign a high-impact label.
7+
3. Assign high-impact issues to either themselves or a [core maintainer](https://github.com/containers/podman/blob/main/OWNERS#L1).
8+
4. If [essential information is lacking](#checks-for-triaging), request it from the submitter and apply the 'needs-info' label.
9+
5. Once all the necessary information is gathered, the maintainer will assign the high-impact label if needed and removes the ‘needs-info’ label
10+
6. Check our [issue closing policy](https://github.com/containers/podman/blob/main/ISSUE.md#why-was-my-issue-report-closed) and close the new issue if it matches the listed criteria.
11+
12+
13+
## Checks for triaging
14+
While triaging, the maintainer has to look for the following information in the issue and ask the reporter for any missing information.
15+
16+
### Bugs:
17+
1. Check what version of Podman, the distro, and any pertinent environmental notes the reporter is experiencing the problem on. This should come in the form of podman info as the issue template states.
18+
2. If the issue is distribution specific, then suggest in the comment that it should also be brought to the attention of the distribution and close the issue.
19+
3. If the reporter is not using the latest (or very near latest) version of Podman, the reporter should be asked to verify this still exists in main or at least in the latest release. The triager can also verify this.
20+
4. Check if there is a good reproducer that preferably reproduces on the latest Podman version
21+
5. Any other missing information that could help with debugging.
22+
6. Check for similar issues and act accordingly
23+
7. If the issue is related to Brew. Chocolatey or another package manager, suggest the reporter to use the latest binaries on the release page
24+
25+
### Features:
26+
1. Check if the feature is already added to the newer Podman releases, if it is, add the appropriate suggestion and close the issue.
27+
2. Check if the feature is reasonable and is under the project’s scope
28+
3. Check if the feature is clear and ask for any missing information.
29+
30+
31+
### High Impact Bug Definition
32+
1. An issue that impacts multiple users
33+
2. An issue that is encountered on each run of Podman
34+
3. An issue that breaks basic Podman functionality like `podman run` or `podman build`
35+
4. A regression caused by new release
36+
37+
## Labels:
38+
1. network
39+
2. quadlet
40+
3. machine
41+
4. kube
42+
5. storage
43+
6. build
44+
7. windows
45+
8. macos
46+
9. documentation
47+
10. pasta
48+
11. remote
49+
12. compose
50+
13. regression

0 commit comments

Comments
 (0)