Issue and Pull Request templates

#1

Post by joshmanders » Wed, Feb 17, 2016, 5:20 PM UTC

Issue and Pull Request templates
github.com

Re: Issue and Pull Request templates

#2

Post by minimaxir » Wed, Feb 17, 2016, 5:36 PM UTC

The template is more for actual issues with the software than to-do lists/user grievances, the latter of which I see used more frequently in GitHub Issues. Maybe it's time to separate GitHub Issues into Issues and Discussion.

EDIT: Missed the fact that the feature is opt-in by the repo owner, which makes things more expected depending on the nature of the repo. Although now thinking about it, the separation is still not a bad idea.

Re: Issue and Pull Request templates

#3

Post by dimgl » Wed, Feb 17, 2016, 5:40 PM UTC

minimaxir wrote: post #2

The template is more for actual issues with the software than to-do lists/user grievances, the latter of which I see used more frequently in GitHub Issues. Maybe it's time to separate GitHub Issues into Issues and Discussion. EDIT: Missed the fact that the feature is opt-in by the repo owner, which makes things more expected depending on the nature of the repo. Although now thinking about it, the separation is still…

I don't agree. I think this is a great step into encouraging users to follow a format when submitting issues. It would make it easier to add tags to these issues as well. Any other discussion can be submitted the same way, you'd just remove the template and start typing.

Re: Issue and Pull Request templates

#4

Post by joshmanders » Wed, Feb 17, 2016, 5:42 PM UTC

dimgl wrote: post #3

minimaxir wrote: post #2

The template is more for actual issues with the software than to-do lists/user grievances, the latter of which I see used more frequently in GitHub Issues. Maybe it's time to separate GitHub Issues into Issues and Discussion. EDIT: Missed the fact that the feature is opt-in by the repo owner, which makes things more expected depending on the nature of the repo. Although now thinking about it, the separation is still…

I don't agree. I think this is a great step into encouraging users to follow a format when submitting issues. It would make it easier to add tags to these issues as well. Any other discussion can be submitted the same way, you'd just remove the template and start typing.

Indeed. Triaging issues which is a huge issue can now be simplified heavily with the usage of a bot that parses the template and tags issues.

This is a great step forward and I'm excited that GitHub is doing this.

Re: Issue and Pull Request templates

#5

Post by lr » Wed, Feb 17, 2016, 5:44 PM UTC

I asked Craigslist to do this years ago for the "for sale" sections, so that people included the number of doors on a car, the color, etc., and the kind of heat in an apartment, and so on. Such a simple thing, and would make searching so much better, and the service in general better.

Re: Issue and Pull Request templates

#6

Post by [deleted] » Wed, Feb 17, 2016, 5:50 PM UTC

dimgl wrote: post #3

minimaxir wrote: post #2

The template is more for actual issues with the software than to-do lists/user grievances, the latter of which I see used more frequently in GitHub Issues. Maybe it's time to separate GitHub Issues into Issues and Discussion. EDIT: Missed the fact that the feature is opt-in by the repo owner, which makes things more expected depending on the nature of the repo. Although now thinking about it, the separation is still…

I don't agree. I think this is a great step into encouraging users to follow a format when submitting issues. It would make it easier to add tags to these issues as well. Any other discussion can be submitted the same way, you'd just remove the template and start typing.

[deleted]

Re: Issue and Pull Request templates

#7

Post by guipsp » Wed, Feb 17, 2016, 5:53 PM UTC

[deleted] wrote: post #6

dimgl wrote: post #3

Earlier quoted context omitted.

I don't agree. I think this is a great step into encouraging users to follow a format when submitting issues. It would make it easier to add tags to these issues as well. Any other discussion can be submitted the same way, you'd just remove the template and start typing.

[deleted]

The template is pulled from the repo.

Re: Issue and Pull Request templates

#8

Post by VeejayRampay » Wed, Feb 17, 2016, 5:54 PM UTC

Well done Github. Simple and elegant solution that I hope will help people a lot.

Re: Issue and Pull Request templates

#9

Post by kuschku » Wed, Feb 17, 2016, 5:58 PM UTC

It’d be interesting if it’d provide a separate input box for each section of the template – maybe even a graphical editor for lists if the template specifies a list.

Re: Issue and Pull Request templates

#10

Post by garethadams » Wed, Feb 17, 2016, 6:00 PM UTC

guipsp wrote: post #7

[deleted] wrote: post #6

Earlier quoted context omitted.

[deleted]

The template is pulled from the repo.

Right, see:

New issue: https://github.com/owncloud/core/issues/new

issue_template.md file in repo: https://github.com/owncloud/core/blob/master/issue_template....