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

Conversation

mohanboddu
Copy link

@mohanboddu mohanboddu commented Nov 21, 2022

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 [email protected]

Does this PR introduce a user-facing change?

None

@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/release-note-label-needed Enforce release-note requirement, even if just None labels Nov 21, 2022
@Luap99
Copy link
Member

Luap99 commented Nov 21, 2022

@mohanboddu Can you enable this on your fork so I could test it there? I much rather try it than looking at yaml.

Copy link
Member

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

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

Most of the requested dropdown selections are already visible podman info. If I fill a bug I don't want to provide the same info twice.
Would it be possible to let users paste in podman info and only if podman info is not working (e.g. on macos with broken machine) asking the questions?


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.

If you are filing a bug against `podman build`, please instead file a bug 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.
Copy link
Member

Choose a reason for hiding this comment

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

Honestly I am not even sure if this is still true. A lot of bugs are related to podman-remote build which must also be fixed in podman.
We can move the issue over to the buildah repo if it has to be fixed there, in the podman repo we get at least more eyeballs on new issues.

Copy link
Collaborator

Choose a reason for hiding this comment

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

True, I think podman build bugs should be manually triaged to buildah if its needed, in most cases its compat API or podman-remote build which is indeed a podman issue.

Comment on lines 32 to 36
- 3.4
- 3.3
- 3.2
- 3.1
- 3.0
Copy link
Member

Choose a reason for hiding this comment

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

I wouldn't even offer 3.X versions. We have no plans of supporting them. People should verify their bugs against the latest versions.

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

Copy link
Member

@edsantiago edsantiago left a comment

Choose a reason for hiding this comment

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

I like the split between bug and feature. I don't like all the new structure. For bugs, we really should insist on podman info output: it is both easier and more reliable than anything entered by a human.

name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
Copy link
Member

Choose a reason for hiding this comment

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

Should that be kind/bug?

And, the triage label does not exist. This is a good opportunity to decide if that's the best name, or it should be triage-needed or something else. (Also, it's not clear to me what is meant here by "triage". Assign to someone? Sub-categorize?)

Copy link
Author

Choose a reason for hiding this comment

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

Fixed the kind/bug part, updated triage to traige-needed for now.

Comment on lines +8 to +9
value: |
Thanks for taking the time to fill out this bug report!
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

Comment on lines 26 to 25
options:
- main
Copy link
Member

Choose a reason for hiding this comment

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

Clicky-stuff is pretty at first glance, but a hindrance to experts. This list will be Yet Another Thing to be hand-maintained over time, and it's likely not to even be useful because people will likely fill it in inconsistently. Can we nuke it?

Copy link
Member

Choose a reason for hiding this comment

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

I am also in favor of nuking.

podman info shows that information

id: os
attributes:
label: Operating System
description: What operating system are you using?
Copy link
Member

Choose a reason for hiding this comment

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

This, too, is in podman info. I don't see how this is a useful addition to our template.

Copy link
Member

Choose a reason for hiding this comment

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

I am also in favor of nuking.

podman info shows that information

It's not listing Debian and OpenSUSE, for instance, but puts all RH distros first.

.github/ISSUE_TEMPLATE/feature_request.yaml Outdated Show resolved Hide resolved
@mohanboddu
Copy link
Author

Most of the requested dropdown selections are already visible podman info. If I fill a bug I don't want to provide the same info twice. Would it be possible to let users paste in podman info and only if podman info is not working (e.g. on macos with broken machine) asking the questions?

Clicky-stuff is pretty at first glance, but a hindrance to experts. This list will be Yet Another Thing to be hand-maintained over time, and it's likely not to even be useful because people will likely fill it in inconsistently. Can we nuke it?

@Luap99 @edsantiago I hear your concerns, lets discuss in the next meeting and will make the changes as per the discussion.

@mohanboddu mohanboddu force-pushed the issue_templates branch 2 times, most recently from ae2a111 to f8ff8b2 Compare November 21, 2022 22:20
@mohanboddu
Copy link
Author

@mohanboddu Can you enable this on your fork so I could test it there? I much rather try it than looking at yaml.

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?

@Luap99 @edsantiago please take a look at https://github.com/mohanboddu/podman/issues/new/choose, I hope this helps to clear some of your questions

Copy link
Member

@vrothberg vrothberg left a comment

Choose a reason for hiding this comment

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

I would love to test this first.

I am afraid there are too many questions that would personally annoy me a lot. Opening an issue or bug should be as easy as possible IMO.

I think that many questions don't need to be answered as podman info shows that data.

Comment on lines 26 to 25
options:
- main
Copy link
Member

Choose a reason for hiding this comment

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

I am also in favor of nuking.

podman info shows that information

id: os
attributes:
label: Operating System
description: What operating system are you using?
Copy link
Member

Choose a reason for hiding this comment

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

I am also in favor of nuking.

podman info shows that information

It's not listing Debian and OpenSUSE, for instance, but puts all RH distros first.

@vrothberg
Copy link
Member

@mohanboddu Can you enable this on your fork so I could test it there? I much rather try it than looking at yaml.

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?

@Luap99 @edsantiago please take a look at https://github.com/mohanboddu/podman/issues/new/choose, I hope this helps to clear some of your questions

I like the workflow there a lot! I am sure we can address the open concerns.

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 28, 2022
@mohanboddu mohanboddu force-pushed the issue_templates branch 2 times, most recently from 7ee37a4 to c160f04 Compare November 29, 2022 16:01
@mohanboddu mohanboddu changed the title [WIP] Update the issue templates Update the issue templates Nov 29, 2022
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 29, 2022
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 29, 2022
@Luap99
Copy link
Member

Luap99 commented Nov 29, 2022

@Luap99 @edsantiago please take a look at https://github.com/mohanboddu/podman/issues/new/choose, I hope this helps to clear some of your questions

Thanks, this looks very nice.

You have some validate problems with trailing white spaces.

@mohanboddu mohanboddu force-pushed the issue_templates branch 2 times, most recently from 25fd1cf to 41050ac Compare November 30, 2022 03:51
Copy link
Member

@vrothberg vrothberg left a comment

Choose a reason for hiding this comment

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

Just one final nit but LGTM. Thanks a lot!

.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
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 <[email protected]>
@mohanboddu
Copy link
Author

You have some validate problems with trailing white spaces.

Thanks @Luap99 , I fixed the trailing white spaces

@github-actions
Copy link

A friendly reminder that this PR had no activity for 30 days.

@rhatdan
Copy link
Member

rhatdan commented Jan 3, 2023

@mohanboddu Is this ready to go in?

@mohanboddu
Copy link
Author

@rhatdan I have addressed all the comments in the PR, it should be good to go if there are no other concerns.

@openshift-ci openshift-ci bot added release-note-none and removed do-not-merge/release-note-label-needed Enforce release-note requirement, even if just None labels Jan 3, 2023
@rhatdan rhatdan added do-not-merge/release-note-label-needed Enforce release-note requirement, even if just None and removed stale-pr release-note-none labels Jan 3, 2023
@openshift-ci openshift-ci bot added release-note-none and removed do-not-merge/release-note-label-needed Enforce release-note requirement, even if just None labels Jan 3, 2023
@rhatdan
Copy link
Member

rhatdan commented Jan 3, 2023

/lgtm
/approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 3, 2023
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 3, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mohanboddu, rhatdan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 3, 2023
@openshift-merge-robot openshift-merge-robot merged commit 2dcf6b1 into containers:main Jan 3, 2023
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 16, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. release-note-none
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants