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

Adopt multiple issue templates #68774

Merged

Conversation

@shubheksha
Copy link
Contributor

commented Sep 18, 2018

What this PR does / why we need it:
This PR adds multiple issue templates for various common issues encountered to simplify issue filing.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #68527

Special notes for your reviewer: N/A

Release note:

NONE

/cc @cblecker

@shubheksha

This comment has been minimized.

Copy link
Contributor Author

commented Sep 18, 2018

cc: @justaugustus @guineveresaenger @BenTheElder added fields that made sense for a first pass, would appreciate y'all chiming in :)

@shubheksha

This comment has been minimized.

Copy link
Contributor Author

commented Sep 18, 2018

/sig contributor-experience

@cblecker
Copy link
Member

left a comment

Two comments right off the top:

@guineveresaenger
Copy link
Contributor

left a comment

Thank you Shubheksha!

So we actually have a few more kind/ labels than represented here. Should they all have their own template?

I'm thinking the kind/cleanup at least should have its own template, but maybe kind/flake should not, as the response to that is very similar as to kind/failing-test.
I've also never seen kind/api-change but thay may just be me...

Is there an obvious way to remove the template for things that don't fit these boxes? (not sure how this plays out in reality).

Here's a link to the current kind/ labels:
https://github.com/kubernetes/kubernetes/labels?page=4&sort=name-asc

@@ -0,0 +1,10 @@
<!-- Please use this template only for submitting feature requests or enhancements -->

This comment has been minimized.

Copy link
@guineveresaenger

guineveresaenger Sep 18, 2018

Contributor

Add language to mention KEPs for larger, in-depth enhancements.

Also, in k/k, often issues get filed as parts of milestone features, so it might be a good idea to remind folks to link to the related feature in k/features? I'm a bit fuzzy on the process.

This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

Also, in k/k, often issues get filed as parts of milestone features, so it might be a good idea to remind folks to link to the related feature in k/features?

k/features is more like an umbrella issue for features that have been approved by a SIG. Feature requests in k/k are more the enhancement-sort and are also requested by users. Most of the kind/feature issues do not really talk about features big enough or matured enough to have a related feature in k/features.

Also, from what I understand with @justaugustus's KEP, the idea is to rename k/features as k/keps. In that case, maybe we shouldn't point users to k/features...it might lead to a spam of feature requests there. :/

This comment has been minimized.

Copy link
@shubheksha

shubheksha Sep 18, 2018

Author Contributor

Yup, that makes sense in my head. Which is why using enhancements instead of features also makes sense.

This comment has been minimized.

This comment has been minimized.

Copy link
@justaugustus

justaugustus Sep 29, 2018

Member

Instead: Please only use this template for submitting enhancement requests

This comment has been minimized.

Copy link
@justaugustus

justaugustus Sep 29, 2018

Member

To add to the conversation:

  • no need to mention KEPs here. Anyone submitting an enhancement request should not require intimate knowledge of PM process. We'll assume / hope that these submissions are vetted by someone more project adjacent to ensure they get routed correctly.
  • k/features will be renamed to k/enhancements, to represent the union of work captured in both KEPs (multi-cycle work) and Features (approximately single-cycle work). Formal definitions forthcoming, but that's the general gist.

For anyone interested in reading more:

@@ -0,0 +1,20 @@
<!-- Please submit an issue as per the template, not doing so may result in your issue not being addressed in a timely manner. Thanks!-->

This comment has been minimized.

Copy link
@guineveresaenger

guineveresaenger Sep 18, 2018

Contributor

nit: I think "Please use this template when reporting a bug. Not {...} " might be clearer. I think it's good to avoid using the word "issue" since that can mean more things than "bug", as in "feature issue" "cleanup issue" etc.


**Testgrid link**

**Triage**

This comment has been minimized.

Copy link
@guineveresaenger

guineveresaenger Sep 18, 2018

Contributor

what is Triage in this case? Not sure we need this header, I'd have no idea what to put there, and I'm just finishing a release as bug triage lead...

This comment has been minimized.

Copy link
@shubheksha

shubheksha Sep 18, 2018

Author Contributor

I added that field based on some of the recent kind/failing-test issues I encountered in k/k. The idea was to provide what is causing the test to fail according to the person filing the issue.

This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

The idea was to provide what is causing the test to fail according to the person filing the issue.

Can this go in Anything else we need to know or be renamed as Why it might be failing or something like that?

This comment has been minimized.

Copy link
@shubheksha

shubheksha Sep 18, 2018

Author Contributor

Also, should this be Failing/Flaky test or should they be different templates?

This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

Also, should this be Failing/Flaky test or should they be different templates?

I think it could be clubbed together...maybe a commented /kind flake mentioning to uncomment it when the test is a flaky one?

As an aside: should this be area/flake instead?
/cc @spiffxp

This comment has been minimized.

Copy link
@shubheksha

shubheksha Sep 18, 2018

Author Contributor

That usually causes chaos as is the case with kind/feature and kind/bug right now in k/k. :/

Show resolved Hide resolved .github/ISSUE_TEMPLATE/support.md
@nikhita
Copy link
Member

left a comment

Thanks for working on this, @shubheksha! 🎉


/kind bug


This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

nit: empty newline

If you're looking for help check [Stack Overflow](https://stackoverflow.com/questions/tagged/kubernetes) and the [troubleshooting guide](https://kubernetes.io/docs/tasks/debug-application-cluster/troubleshooting/).
You can also post your question on the [Kubernetes Slack](http://slack.k8s.io/) or the [Discuss Kubenetes](https://discuss.kubernetes.io/) forum.

This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

link to the kubernetes-users channel on slack might be better?

@@ -0,0 +1,10 @@
<!-- Please use this template only for submitting feature requests or enhancements -->

This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

Also, in k/k, often issues get filed as parts of milestone features, so it might be a good idea to remind folks to link to the related feature in k/features?

k/features is more like an umbrella issue for features that have been approved by a SIG. Feature requests in k/k are more the enhancement-sort and are also requested by users. Most of the kind/feature issues do not really talk about features big enough or matured enough to have a related feature in k/features.

Also, from what I understand with @justaugustus's KEP, the idea is to rename k/features as k/keps. In that case, maybe we shouldn't point users to k/features...it might lead to a spam of feature requests there. :/

/kind feature


**What would you like to add**

This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

Two points here:

  1. I think it would be useful to have an alternate wording of "what happened" and "what you expected to happen" because it holds true for feature/enhancement requests too. Most feature requests start out as "I did X and was expecting Y, but I got Z. I think it would be cool to add a feature to get the output as Z". Getting output as Z is not always a bug, it could also mean adding a new feature.

  2. Would prefer this question as What would you like to be added or something like that. Usually the person submitting the feature request is not the one implementing it. ;)


**Testgrid link**

**Triage**

This comment has been minimized.

Copy link
@nikhita

nikhita Sep 18, 2018

Member

The idea was to provide what is causing the test to fail according to the person filing the issue.

Can this go in Anything else we need to know or be renamed as Why it might be failing or something like that?

@nikhita

This comment has been minimized.

Copy link
Member

commented Sep 18, 2018

/kind feature

@k8s-ci-robot k8s-ci-robot requested a review from spiffxp Sep 18, 2018

@k8s-ci-robot k8s-ci-robot added size/L and removed size/M labels Sep 18, 2018

@nikhita

This comment has been minimized.

Copy link
Member

commented Sep 18, 2018

I'm thinking the kind/cleanup at least should have its own template, but maybe kind/flake should not, as the response to that is very similar as to kind/failing-test.

+1 to kind/cleanup and we should also include a template for "Other" requests i.e. requests that don't "seem" to fall under any of these.

I've also never seen kind/api-change but thay may just be me...

https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fapi-change :)

I think api-change is more of an area/ though? An issue can be a bug or a feature and it can affect the API...

@BenTheElder

This comment has been minimized.

Copy link
Member

commented Sep 19, 2018

I'm really behind on PR reviews etc at the moment but I wanted to say thanks for working on this!! It looks like you're in good hands getting this reviewed already thankfully :-)

@shubheksha shubheksha referenced this pull request Sep 19, 2018

Closed

Octobox won't sync #965

1 of 2 tasks complete
@justaugustus

This comment has been minimized.

Copy link
Member

commented Sep 19, 2018

/cc
(so I don't forget to review this!)

Thanks again @shubheksha for working on this! :)

@k8s-ci-robot k8s-ci-robot requested a review from justaugustus Sep 19, 2018

@shubheksha

This comment has been minimized.

Copy link
Contributor Author

commented Sep 19, 2018

@cblecker, addressed your comments, PTAL 😃

@cblecker cblecker self-assigned this Sep 24, 2018

@justaugustus
Copy link
Member

left a comment

@shubheksha -- just a few grammar nits and a notes w.r.t. the language around Enhancements

@@ -0,0 +1,15 @@
---
name: Enhancement Request
about: Feature or enhancement request

This comment has been minimized.

Copy link
@justaugustus

justaugustus Sep 29, 2018

Member

Instead: Suggest an enhancement to the Kubernetes project

@@ -0,0 +1,10 @@
<!-- Please use this template only for submitting feature requests or enhancements -->

This comment has been minimized.

Copy link
@justaugustus

justaugustus Sep 29, 2018

Member

Instead: Please only use this template for submitting enhancement requests

@@ -0,0 +1,10 @@
<!-- Please use this template only for submitting feature requests or enhancements -->

This comment has been minimized.

Copy link
@justaugustus

justaugustus Sep 29, 2018

Member

To add to the conversation:

  • no need to mention KEPs here. Anyone submitting an enhancement request should not require intimate knowledge of PM process. We'll assume / hope that these submissions are vetted by someone more project adjacent to ensure they get routed correctly.
  • k/features will be renamed to k/enhancements, to represent the union of work captured in both KEPs (multi-cycle work) and Features (approximately single-cycle work). Formal definitions forthcoming, but that's the general gist.

For anyone interested in reading more:

Show resolved Hide resolved .github/ISSUE_TEMPLATE/failing-test.md Outdated
Show resolved Hide resolved .github/ISSUE_TEMPLATE/support.md Outdated
@justaugustus

This comment has been minimized.

Copy link
Member

commented Sep 29, 2018

I'm thinking the kind/cleanup at least should have its own template, but maybe kind/flake should not, as the response to that is very similar as to kind/failing-test.

+1 to kind/cleanup and we should also include a template for "Other" requests i.e. requests that don't "seem" to fall under any of these.

I'd prefer to see less templates over more. I think we successfully cover enough base cases here for this to be valuable. We could make the argument that removing dead code is an enhancement.

I also like that less templates act as forcing function for submitters to more deeply consider what their submission should be classified as. Of course, anyone with sufficient knowledge of the project could simply choose to use one of the labels not listed here instead.

I've also never seen kind/api-change but thay may just be me...

https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fapi-change :)

I think api-change is more of an area/ though? An issue can be a bug or a feature and it can affect the API...

I think of kind/* as code-related and area/* as a ~"subproject" classification.

@justaugustus

This comment has been minimized.

Copy link
Member

commented Oct 16, 2018

Bump

@nikhita

This comment has been minimized.

Copy link
Member

commented Oct 23, 2018

This needs to sync with #69837

@nikhita

This comment has been minimized.

Copy link
Member

commented Oct 24, 2018

I'd prefer to see less templates over more. I think we successfully cover enough base cases here for this to be valuable. We could make the argument that removing dead code is an enhancement.

While I agree that removing dead code is an "enhancement", I am concerned that it could create problems for folks triaging issues since they won't truly be "features" (we label enhancements as kind/feature). :)

There are 97 issues today with kind/cleanup and I see issues created almost daily that should fall under "cleanups and refactoring".

I still think we need another template for cleanups and/or a template for "Others" (though the latter might be too ambiguous and lead to wrong use). Thoughts?

@justaugustus

This comment has been minimized.

Copy link
Member

commented Oct 24, 2018

@nikhita -- I fallback on my previous comment:

I also like that less templates act as forcing function for submitters to more deeply consider what their submission should be classified as. Of course, anyone with sufficient knowledge of the project could simply choose to use one of the labels not listed here instead.

I don't have a strong opinion here, outside of wanting to see this merge soon, so whatever y'all decide, my lgtm stands.

@cblecker
Copy link
Member

left a comment

Thank you so much for doing this! One last round of changes, and I think this is good to go. 🥇 🚀


<!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!-->

/kind bug

This comment has been minimized.

Copy link
@cblecker

cblecker Oct 24, 2018

Member

For all the commands, like /kind bug can we do something similar to this where we put them at the bottom with <!-- DO NOT EDIT BELOW THIS LINE --> proceeding them?

This comment has been minimized.

Copy link
@shubheksha

shubheksha Oct 24, 2018

Author Contributor

Good idea!

/kind feature


**What would you like to be added**

This comment has been minimized.

Copy link
@cblecker

cblecker Oct 24, 2018

Member

nit: colon at end (same for all the rest of the questions)

@@ -0,0 +1,21 @@
---
name: Failing Test
about: Report test failures

This comment has been minimized.

Copy link
@cblecker

cblecker Oct 24, 2018

Member

Let's be slightly more specific.. Report test failures in Kubernetes CI jobs


---

<!-- Please only use this template for submitting reports about failing tests -->

This comment has been minimized.

Copy link
@cblecker

cblecker Oct 24, 2018

Member

Same here.. can we call out this should only be for Kubernetes CI test failures, not other kinds of possible failing tests

@cblecker

This comment has been minimized.

Copy link
Member

commented Oct 24, 2018

@nikhita @justaugustus My thoughts are this is a great start, and we can iterate over time if we need additional templates. These templates don't prevent people from erasing everything and submitting any issue they want.. they do it today already 😆

@k8s-ci-robot k8s-ci-robot removed the lgtm label Oct 24, 2018

@shubheksha

This comment has been minimized.

Copy link
Contributor Author

commented Oct 24, 2018

@cblecker, done!

@cblecker
Copy link
Member

left a comment

/lgtm
/approve
/hold

Thanks @shubheksha! I'm going to put a hold on this for any last comments from @nikhita or @justaugustus, but feel free to remove this tomorrow if there are no objections.

@k8s-ci-robot

This comment has been minimized.

Copy link
Contributor

commented Oct 24, 2018

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cblecker, justaugustus, shubheksha

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

@nikhita

This comment has been minimized.

Copy link
Member

commented Oct 25, 2018

These templates don't prevent people from erasing everything and submitting any issue they want.. they do it today already

Lol true. Sgtm.

I don't have a strong opinion here, outside of wanting to see this merge soon, so whatever y'all decide, my lgtm stands.

From this, I'll assume @justaugustus wants to get this in. Removing the hold.

Thanks a lot for working on this, @shubheksha! This is a huge improvement! 🚀

/hold cancel

@k8s-ci-robot k8s-ci-robot merged commit f282543 into kubernetes:master Oct 25, 2018

18 checks passed

cla/linuxfoundation shubheksha authorized
Details
pull-kubernetes-bazel-build Job succeeded.
Details
pull-kubernetes-bazel-test Job succeeded.
Details
pull-kubernetes-cross Skipped
pull-kubernetes-e2e-gce Job succeeded.
Details
pull-kubernetes-e2e-gce-100-performance Job succeeded.
Details
pull-kubernetes-e2e-gce-device-plugin-gpu Job succeeded.
Details
pull-kubernetes-e2e-gke Skipped
pull-kubernetes-e2e-kops-aws Job succeeded.
Details
pull-kubernetes-e2e-kubeadm-gce Skipped
pull-kubernetes-integration Job succeeded.
Details
pull-kubernetes-kubemark-e2e-gce-big Job succeeded.
Details
pull-kubernetes-local-e2e Skipped
pull-kubernetes-local-e2e-containerized Skipped
pull-kubernetes-node-e2e Job succeeded.
Details
pull-kubernetes-typecheck Job succeeded.
Details
pull-kubernetes-verify Job succeeded.
Details
tide In merge pool.
Details

vithati added a commit to vithati/kubernetes that referenced this pull request Oct 25, 2018

Adopt multiple issue templates (kubernetes#68774)
* add support for multiple issue templates

* add comment to precede the kind label
@justaugustus

This comment has been minimized.

Copy link
Member

commented Oct 26, 2018

Ditto! Thanks @shubheksha! :)

skbly7 added a commit to skbly7/website-1 that referenced this pull request Oct 30, 2018

Updated broken link to Issue Template
This links seems to be broken after the kubernetes/kubernetes#68774 merge.

k8s-ci-robot added a commit to kubernetes/website that referenced this pull request Nov 1, 2018

Updated broken link to Issue Template (#10781)
This links seems to be broken after the kubernetes/kubernetes#68774 merge.

goodluckbot added a commit to goodluckbot/kubernetes that referenced this pull request Nov 11, 2018

Adopt multiple issue templates (kubernetes#68774)
* add support for multiple issue templates

* add comment to precede the kind label

goodluckbot added a commit to goodluckbot/kubernetes that referenced this pull request Nov 11, 2018

Fix typo in Bug Report issue template
Related to kubernetes#68774

Signed-off-by: Hart Hoover <hart@heptio.com>

phenixblue added a commit to phenixblue/kubernetes that referenced this pull request Jan 24, 2019

Adopt multiple issue templates (kubernetes#68774)
* add support for multiple issue templates

* add comment to precede the kind label

phenixblue added a commit to phenixblue/kubernetes that referenced this pull request Jan 24, 2019

Fix typo in Bug Report issue template
Related to kubernetes#68774

Signed-off-by: Hart Hoover <hart@heptio.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.