Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

docs: update issue templates #1382

Merged
merged 4 commits into from
May 29, 2019
Merged

docs: update issue templates #1382

merged 4 commits into from
May 29, 2019

Conversation

mboersma
Copy link
Member

@mboersma mboersma commented May 28, 2019

Reason for Change:
Adds separate issue and feature issue templates initially generated by the GH wizard. These should be more targeted and less verbose, but I would love feedback on how to make them more user-friendly.

Issue Fixed:
Fixes #1381

Requirements:

Notes:

@acs-bot acs-bot added the size/M label May 28, 2019
@mboersma mboersma changed the title docs: update issue templates [WIP] docs: update issue templates May 28, 2019
@mboersma mboersma changed the title [WIP] docs: update issue templates docs: update issue templates May 28, 2019
@mboersma mboersma requested a review from craiglpeters May 28, 2019 20:32

**Describe alternatives you've considered**

**Additional context**
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd add something like "why is this needed" , ie. convince us that we want this

Copy link
Member Author

Choose a reason for hiding this comment

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

That's important, so I added it as the second section in feature request template.

@CecileRobertMichon
Copy link
Contributor

Kubernetes also has failing test and support. It's pretty cool that we can customize these to add specific categories. Do you think having a support or question category is overkill? I guess for those people can use the "regular issue" button.

https://github.com/kubernetes/kubernetes/tree/master/.github/ISSUE_TEMPLATE

@@ -1,42 +0,0 @@
<!-- Thanks for filing an issue! Before hitting the button, please answer these questions. It's helpful to search the existing GitHub issues first. It's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of-->

**Is this a request for help?**:
Copy link
Contributor

Choose a reason for hiding this comment

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

looking forward to getting rid of this... I don't think I've ever seen someone answer "no" to "Is this a request for help?"

@mboersma
Copy link
Member Author

Do you think having a support or question category is overkill?

Not necessarily—I almost added a "question" template when creating this. Maybe for now we use "bug," "feature," and the "regular issue" link and see how it goes?

Copy link
Contributor

@CecileRobertMichon CecileRobertMichon left a comment

Choose a reason for hiding this comment

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

lgtm

@codecov
Copy link

codecov bot commented May 29, 2019

Codecov Report

Merging #1382 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #1382   +/-   ##
======================================
  Coverage    75.5%   75.5%           
======================================
  Files         128     128           
  Lines       18141   18141           
======================================
  Hits        13697   13697           
  Misses       3641    3641           
  Partials      803     803

@jackfrancis
Copy link
Member

/lgtm

@acs-bot
Copy link

acs-bot commented May 29, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon, jackfrancis, mboersma

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:
  • OWNERS [CecileRobertMichon,jackfrancis,mboersma]

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refresh issue creation template
4 participants