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

Add an issue template, tighten PR template #30167

Merged
merged 2 commits into from
Aug 12, 2016

Conversation

janetkuo
Copy link
Member

@janetkuo janetkuo commented Aug 5, 2016

Supersedes #28488


This change is Reviewable

@janetkuo janetkuo added release-note-none Denotes a PR that doesn't merit a release note. and removed cla: yes labels Aug 5, 2016
BUG REPORT
----------

*Kubernetes version*: (try `kubctl version`)
Copy link
Contributor

Choose a reason for hiding this comment

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

Drive-by nit: s/kubctl/kubectl

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

@k8s-github-robot k8s-github-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. retest-not-required-docs-only labels Aug 5, 2016
@janetkuo
Copy link
Member Author

janetkuo commented Aug 5, 2016

Is this a request for help (If yes, you should instead post it in StackOverflow, Slack channel, or mailing list, see http://kubernetes.io/docs/troubleshooting/.):

What keywords did you search in Kubernetes issues before filing this one (If you found any duplicates, you should instead reply there or use the 👍 icon in the upper-right of the issue message):


Is this a BUG REPORT or FEATURE REQUEST (choose one):

Kubernetes version (use kubectl version):

Environment:

  • Cloud provider:
  • OS:
  • kernel:
  • Install tools:
  • Others:

What happened:

What you expected to happen:

How to reproduce it (as minimally and precisely as possible):

Anything else do we need to know:

@janetkuo
Copy link
Member Author

janetkuo commented Aug 5, 2016

What this PR does / why we need it:

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

Special notes for your reviewer:

Release note:

* Enter your extended release note here (newlines are formatted as bullets).  If this PR does not warrant a release
  note, just say `NONE`.
-OR-
* Use the release-note-* labels to set the release note state (if you have access)
* Clear this block to use the PR title as the release note

@janetkuo
Copy link
Member Author

janetkuo commented Aug 5, 2016

The above is how current issue & PR template looks, major changes include:

  • Addressed all comments in previous PR Add an issue template, tighten PR template #28488
  • Make it shorter (so people will read it)
  • Removed PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING (it won't display anyways so let's save this space)
  • Made all "read this and that paragraph" more Q&A-ish (so people can't ignore it)

@janetkuo janetkuo force-pushed the issue-pr-template branch 2 times, most recently from ff20f6b to e867e3a Compare August 6, 2016 19:57
@janetkuo
Copy link
Member Author

janetkuo commented Aug 8, 2016

@bgrant0607 ptal

@bgrant0607 bgrant0607 removed their assignment Aug 11, 2016
@@ -0,0 +1,47 @@
<!-- Thanks for filing an issue! Before hitting the button, please answer these questions.-->

**Is this a request for help** (If yes, you should instead post it in StackOverflow, Slack channel, or mailing list, see http://kubernetes.io/docs/troubleshooting/.):
Copy link
Contributor

@philips philips Aug 11, 2016

Choose a reason for hiding this comment

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

Perhaps something like: "Is this a request for help (If yes, you should use our troubleshooting guide and community support channels, see http://kubernetes.io/docs/troubleshooting/.)"

@philips
Copy link
Contributor

philips commented Aug 11, 2016

Overall this LGTM.


**Special notes for your reviewer**:

**Release note**:
```release-note
Copy link
Member

Choose a reason for hiding this comment

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

It would be nice if we could make the syntax clear enough to automatically set the release-note labels based on the text here.

@janetkuo
Copy link
Member Author

All comments addressed, @philips @bgrant0607 ptal

@philips
Copy link
Contributor

philips commented Aug 11, 2016

LGTM

thockin and others added 2 commits August 11, 2016 18:25
I looked at a few other examples of templates and tried to make ours more
succint and helpful.  Feedback is welcome.
@janetkuo
Copy link
Member Author

Squashed; applying tag

@janetkuo janetkuo added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 12, 2016
@k8s-bot
Copy link

k8s-bot commented Aug 12, 2016

GCE e2e build/test passed for commit de91512.

@k8s-github-robot
Copy link

Automatic merge from submit-queue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants