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

chore(github): Update issue template to have several choices #13777

Merged
merged 1 commit into from
Jul 12, 2019

Conversation

benoitf
Copy link
Contributor

@benoitf benoitf commented Jul 5, 2019

What does this PR do?

Provide a list of choices when creating issues

Enhance the templates to ask more questions when reporting a bug
image

What issues does this PR fix or reference?

Related to End Game #13637

Fix #13648

Change-Id: I3586957c6687dbdf4b528ccf62bd07e82b2887f1
Signed-off-by: Florent Benoit fbenoit@redhat.com

@benoitf benoitf self-assigned this Jul 5, 2019
@benoitf benoitf added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Jul 5, 2019
@slemeur
Copy link
Contributor

slemeur commented Jul 5, 2019

I love it !

I'm wondering if we need the usability section as this might be related to enhancements?

Order, I would put:

  • Question
  • Bug report
  • Enhancement
  • Usability
  • Documentation
  • Task

But that's great. Thanks @benoitf !

@benoitf
Copy link
Contributor Author

benoitf commented Jul 5, 2019

@slemeur it's because we have kind/usability label
It seems @tsmaeder introduced that label
Maybe you need to see if usability can be merged into enhancement

about: Suggest a documentation item for Eclipse Che
title: ''
labels: 'kind/docs'
assignees: ''
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rkratky we can make you as default assignee as well there

Also we can add the template that you would want for documentation items.

@l0rd
Copy link
Contributor

l0rd commented Jul 5, 2019

Very nice @benoitf . +1 to remove usability. I would even make it simpler and remove:

  • documentation: for me it's an area or component, not a kind. For instance it makes perfectly sense to have kind/enhancement with area/docs
  • task: I always struggle with the difference between a task and an enhancement

@benoitf
Copy link
Contributor Author

benoitf commented Jul 5, 2019

ok so consensus for now is to remove usability (and then remove the label I think ?)

I agree with you that kind/docs is more area/docs now that docs issues are also there

About task, in description (that is in the label) is that it's more technical-debt, something that you should do but it may not be an enhancement at all.
Usage of kind/task is quite widely spread with almost 200 opened issues with that label https://github.com/eclipse/che/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Ftask
If most of people are thinking that task can be merged into enhancement we could reduce the numbers of kind/ item as well

I will not do changes on the PR until beginning of next week to let people comment and grab other feedback.

@sunix
Copy link
Contributor

sunix commented Jul 11, 2019

I will not do changes on the PR until beginning of next week to let people comment and grab other feedback.

Ok, my feedback is that to make some decision like what we take for the release, we take some criteria like:

  • "We do not add more new features for GA" --> enhancement (but should be new feature ?)
  • "We have to update the README to include a contribution section" --> task or doc
  • "We have to update the jenkins job to include the ability to build PR branches" --> task
  • "this flow is ok but it would be nicer to have the button on the top" --> usability .. not a new feature, not really a bug, UX.

Finally would enhancement (that would englobe several kinds of issue) help us in taking decisions and moving forward ? I don't think so.

Also enhance the templates to ask more questions when reporting a bug

Related to End Game #13637

Fix #13648

Change-Id: I3586957c6687dbdf4b528ccf62bd07e82b2887f1
Signed-off-by: Florent Benoit <fbenoit@redhat.com>
@benoitf benoitf marked this pull request as ready for review July 12, 2019 12:35
@benoitf benoitf requested a review from vparfonov as a code owner July 12, 2019 12:35
@benoitf
Copy link
Contributor Author

benoitf commented Jul 12, 2019

@sunix I think you can address some of your remarks with naming convention in your commits
https://www.conventionalcommits.org/

@benoitf
Copy link
Contributor Author

benoitf commented Jul 12, 2019

ci-build

@benoitf
Copy link
Contributor Author

benoitf commented Jul 12, 2019

@slemeur @l0rd PR updated

@slemeur
Copy link
Contributor

slemeur commented Jul 12, 2019

LGTM

@benoitf benoitf merged commit 9b16507 into master Jul 12, 2019
@benoitf benoitf deleted the issue-template branch July 12, 2019 13:03
@sunix
Copy link
Contributor

sunix commented Jul 12, 2019

@sunix I think you can address some of your remarks with naming convention in your commits
https://www.conventionalcommits.org/

yes but before coding (when filling the issue) and while planning (choosing which issue to do next), how can I address that ?

@benoitf
Copy link
Contributor Author

benoitf commented Jul 12, 2019

you can still give issue/PR title with this convention (look at this PR title)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/task Internal things, technical debt, and to-do tasks to be performed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update github templates when submitting new issues
5 participants