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

Ability to pre-fill comment of a new issue with custom bug headers #99

Closed
Whoaa512 opened this Issue Sep 17, 2013 · 39 comments

Comments

Projects
None yet
@Whoaa512

Whoaa512 commented Sep 17, 2013

The idea is to allow users to create custom text that can be used to prefill the comment of a new issue.

Ideally this custom text could be set at the repository level and at the user level. Per repo, both the owner & collaborators would be able to create a set of custom markdown files each containing a list of headers to aid with the bug report & issue tracking process. At the user level, one would be able to create their own set of custom markdown files.

On the UI end, after creating a new issue a dropdown would appear between the tabs of the comment field and the comment about Github Markdown.
screen shot 2013-09-16 at 19 05 26

Dropdown in red, button to prefill the comment field in blue.

This came from reading through a ton of issues today on multiple repositories, which made me a little surprised there wasn't an issue for this already.

@VxJasonxV

This comment has been minimized.

Show comment
Hide comment
@VxJasonxV

VxJasonxV Sep 17, 2013

This can be done relatively easily with simple links and URL encoding. Check out what happens when you use this link: https://github.com/isaacs/github/issues/new?title=foo&body=bar

VxJasonxV commented Sep 17, 2013

This can be done relatively easily with simple links and URL encoding. Check out what happens when you use this link: https://github.com/isaacs/github/issues/new?title=foo&body=bar

@Whoaa512

This comment has been minimized.

Show comment
Hide comment
@Whoaa512

Whoaa512 Sep 18, 2013

Sure, the core functionality to achieve this already exist. However, what I'm proposing is a cleaner interface that would allow the maintainer of a repository to improve their quality of life by setting some sort of optional standard format for that particular repo's issue tracking.

Whoaa512 commented Sep 18, 2013

Sure, the core functionality to achieve this already exist. However, what I'm proposing is a cleaner interface that would allow the maintainer of a repository to improve their quality of life by setting some sort of optional standard format for that particular repo's issue tracking.

@patcon

This comment has been minimized.

Show comment
Hide comment
@patcon

patcon Sep 18, 2013

Hm. Well, GitHub already detects when there's a CONTRIBUTING.md file and links to it at the top of the issue submission form:

Please review the guidelines for contributing to this repository.

Example: https://github.com/drush-ops/drush/issues/new

Perhaps there could be some sort of markdown-compatible front-matter written at the top or bottom of CONTRIBUTING.md that would allow a maintainer to customize this message to get the attention of users. Then the template could simply be explained or linked in that doc.

For example, this might be how the raw version of CONTRIBUTING.md could look:

<!--- Please use the [issue template](https://github.com/drush-ops/drush/blob/master/CONTRIBUTING.md#issue-template) described in Drush's [contribution guidelines](https://github.com/drush-ops/drush/blob/master/CONTRIBUTING.md). --->

Drush is built by people like you! Please [join us](https://github.com/drush-ops/drush).

## Git and Pull requests
* Contributions are submitted, reviewed, and accepted using Github pull requests. [Read this article](https://help.github.com/articles/using-pull-requests) for some details. We use the _Fork and Pull_ model, as described there.
etc. etc

A little less comprehensive, but much less opinionated. And I know github is very conscious of overloading the UI.

Anyhow, just a thought :)

patcon commented Sep 18, 2013

Hm. Well, GitHub already detects when there's a CONTRIBUTING.md file and links to it at the top of the issue submission form:

Please review the guidelines for contributing to this repository.

Example: https://github.com/drush-ops/drush/issues/new

Perhaps there could be some sort of markdown-compatible front-matter written at the top or bottom of CONTRIBUTING.md that would allow a maintainer to customize this message to get the attention of users. Then the template could simply be explained or linked in that doc.

For example, this might be how the raw version of CONTRIBUTING.md could look:

<!--- Please use the [issue template](https://github.com/drush-ops/drush/blob/master/CONTRIBUTING.md#issue-template) described in Drush's [contribution guidelines](https://github.com/drush-ops/drush/blob/master/CONTRIBUTING.md). --->

Drush is built by people like you! Please [join us](https://github.com/drush-ops/drush).

## Git and Pull requests
* Contributions are submitted, reviewed, and accepted using Github pull requests. [Read this article](https://help.github.com/articles/using-pull-requests) for some details. We use the _Fork and Pull_ model, as described there.
etc. etc

A little less comprehensive, but much less opinionated. And I know github is very conscious of overloading the UI.

Anyhow, just a thought :)

@Whoaa512

This comment has been minimized.

Show comment
Hide comment
@Whoaa512

Whoaa512 Sep 18, 2013

That sounds like a great compromise! It really hits the problem at its heart, which is to inform users of how to contribute more effectively. 

Whoaa512 commented Sep 18, 2013

That sounds like a great compromise! It really hits the problem at its heart, which is to inform users of how to contribute more effectively. 

@ryansmith94

This comment has been minimized.

Show comment
Hide comment
@ryansmith94

ryansmith94 Oct 8, 2014

Any update on this?

ryansmith94 commented Oct 8, 2014

Any update on this?

vbatts added a commit to vbatts/moby that referenced this issue Oct 29, 2014

CONTRIBUTING: provide a template for new issues
_maybe_ we could even automate this to populate and complain in some
situations.

I see isaacs/github#99 that is old and needs
some love from @github ...

Signed-off-by: Vincent Batts <vbatts@redhat.com>

vbatts added a commit to vbatts/moby that referenced this issue Nov 19, 2014

CONTRIBUTING: provide a template for new issues
_maybe_ we could even automate this to populate and complain in some
situations.

I see isaacs/github#99 that is old and needs
some love from @github ...

Signed-off-by: Vincent Batts <vbatts@redhat.com>
@mdeguzis

This comment has been minimized.

Show comment
Hide comment
@mdeguzis

mdeguzis Dec 29, 2014

It indeed would be nice to have a template just like Google Code allows. The Contributing.md file is nice, but not obvious enough for some folks who submit issues.

mdeguzis commented Dec 29, 2014

It indeed would be nice to have a template just like Google Code allows. The Contributing.md file is nice, but not obvious enough for some folks who submit issues.

@Pithikos

This comment has been minimized.

Show comment
Hide comment
@Pithikos

Pithikos Jan 5, 2015

@VxJasonxV is there some documentation on what parameters are accepted and where? For example the given example doesn't work when creating new files via a URL.

Pithikos commented Jan 5, 2015

@VxJasonxV is there some documentation on what parameters are accepted and where? For example the given example doesn't work when creating new files via a URL.

@VxJasonxV

This comment has been minimized.

Show comment
Hide comment
@VxJasonxV

VxJasonxV Jan 6, 2015

Documentation of what parameters are accepted is in the HTML source code, the 'name' parameter of input elements. This isn't an API, what I'm demonstrating is really just piggy backing the way that forms in HTML work in browsers. If you want consistency and documentation, use the API.

Creating new files via a URL? What files are we talking about here? Could you give me an example URL of something you've tried?

VxJasonxV commented Jan 6, 2015

Documentation of what parameters are accepted is in the HTML source code, the 'name' parameter of input elements. This isn't an API, what I'm demonstrating is really just piggy backing the way that forms in HTML work in browsers. If you want consistency and documentation, use the API.

Creating new files via a URL? What files are we talking about here? Could you give me an example URL of something you've tried?

@Pithikos

This comment has been minimized.

Show comment
Hide comment
@Pithikos

Pithikos Jan 7, 2015

@VxJasonxV you provided the example: https://github.com/isaacs/github/issues/new?title=foo&body=bar

Following that example I would expect the following link to work: https://github.com/isaacs/github/new/master?filename=foo&content=bar

However it doesn't.. I also tried with body, ace_content and ace_text-input. I do understand there is a limit on the number of characters, but for making something trivial like an introductory comment (ie. <!--PUT YOUR CODE HERE -->) this would be a really nice feature.

Pithikos commented Jan 7, 2015

@VxJasonxV you provided the example: https://github.com/isaacs/github/issues/new?title=foo&body=bar

Following that example I would expect the following link to work: https://github.com/isaacs/github/new/master?filename=foo&content=bar

However it doesn't.. I also tried with body, ace_content and ace_text-input. I do understand there is a limit on the number of characters, but for making something trivial like an introductory comment (ie. <!--PUT YOUR CODE HERE -->) this would be a really nice feature.

@VxJasonxV

This comment has been minimized.

Show comment
Hide comment
@VxJasonxV

VxJasonxV Jan 7, 2015

I have never tried doing this with Ace. Ace is a rich editor, and I don't expect basic HTML form interactivity to work. Again, this is a trivial hack, what you're trying to do is edit content. Why not use git or the API for that?

[edit]
I'm going to reiterate that you should use git or an API for this. But, Ace was just obscuring things. Try this: https://github.com/isaacs/github/new/master?filename=foo&value=bar

VxJasonxV commented Jan 7, 2015

I have never tried doing this with Ace. Ace is a rich editor, and I don't expect basic HTML form interactivity to work. Again, this is a trivial hack, what you're trying to do is edit content. Why not use git or the API for that?

[edit]
I'm going to reiterate that you should use git or an API for this. But, Ace was just obscuring things. Try this: https://github.com/isaacs/github/new/master?filename=foo&value=bar

@Pithikos

This comment has been minimized.

Show comment
Hide comment
@Pithikos

Pithikos Jan 8, 2015

Thanks! That works a treat! B)

Pithikos commented Jan 8, 2015

Thanks! That works a treat! B)

@jrgifford

This comment has been minimized.

Show comment
Hide comment
@jrgifford

jrgifford Jan 26, 2015

@VxJasonxV so your recommendation is that if we want a template for github issues, we should create a form ourselves that lets someone open an issue via the API?

jrgifford commented Jan 26, 2015

@VxJasonxV so your recommendation is that if we want a template for github issues, we should create a form ourselves that lets someone open an issue via the API?

@patcon

This comment has been minimized.

Show comment
Hide comment
@patcon

patcon Jan 26, 2015

Interesting idea @jrgifford. It would seem overkill to auth an app with your account's public_repo scope just to create forms in your name on the very rare occassion, but perhaps it could submit under a common app account. There could be a little footnote at the bottom of the issue like "Submitted on behalf of @patcon using $APP_NAME."

Meh. Just a thought.

patcon commented Jan 26, 2015

Interesting idea @jrgifford. It would seem overkill to auth an app with your account's public_repo scope just to create forms in your name on the very rare occassion, but perhaps it could submit under a common app account. There could be a little footnote at the bottom of the issue like "Submitted on behalf of @patcon using $APP_NAME."

Meh. Just a thought.

@jrgifford

This comment has been minimized.

Show comment
Hide comment
@jrgifford

jrgifford Jan 26, 2015

@patcon well, so in my case, i'm trying to adapt github to be used for change control, so it really should be in that persons name. and it needs to be tagged a certain thing as well.

jrgifford commented Jan 26, 2015

@patcon well, so in my case, i'm trying to adapt github to be used for change control, so it really should be in that persons name. and it needs to be tagged a certain thing as well.

@VxJasonxV

This comment has been minimized.

Show comment
Hide comment
@VxJasonxV

VxJasonxV Jan 26, 2015

If you want to do something on behalf of a user, even simply making a task easier for them, you use the API. Because authentication is involved, the only alternative is something client side like a local program, script, browser extension, etc. But if you want to just give them a webpage they can browse to and fill in just what they need to, there is no other alternative.

VxJasonxV commented Jan 26, 2015

If you want to do something on behalf of a user, even simply making a task easier for them, you use the API. Because authentication is involved, the only alternative is something client side like a local program, script, browser extension, etc. But if you want to just give them a webpage they can browse to and fill in just what they need to, there is no other alternative.

@todb-r7

This comment has been minimized.

Show comment
Hide comment
@todb-r7

todb-r7 Jan 30, 2015

👍 to @patcon's FrontMatter suggestion for pre-filling the issue (and pull request!) title and descriptions. I have found that I need to bonk users over the head repeatedly when filing issues over at rapid7/metasploit-framework, and now that we've moved to GitHub Issues full-time, I'd love to drop reminders directly into the body of the issue.

I will fake it in the meantime with a combination of shortlinks with the URI parameters (Thanks @VxJasonxV ) and then blessed links in CONTRIBUTING.md and README.md, but it'd be great to have this stuff available for people who navigate directly to /issues and /pulls directly, without parameter decorations.

todb-r7 commented Jan 30, 2015

👍 to @patcon's FrontMatter suggestion for pre-filling the issue (and pull request!) title and descriptions. I have found that I need to bonk users over the head repeatedly when filing issues over at rapid7/metasploit-framework, and now that we've moved to GitHub Issues full-time, I'd love to drop reminders directly into the body of the issue.

I will fake it in the meantime with a combination of shortlinks with the URI parameters (Thanks @VxJasonxV ) and then blessed links in CONTRIBUTING.md and README.md, but it'd be great to have this stuff available for people who navigate directly to /issues and /pulls directly, without parameter decorations.

@thockin

This comment has been minimized.

Show comment
Hide comment
@thockin

thockin Jul 14, 2015

This. SO MUCH THIS. Please

thockin commented Jul 14, 2015

This. SO MUCH THIS. Please

@bgrant0607

This comment has been minimized.

Show comment
Hide comment
@bgrant0607

bgrant0607 commented Jul 15, 2015

+1

@dchen1107

This comment has been minimized.

Show comment
Hide comment
@dchen1107

dchen1107 commented Jul 15, 2015

+1000

@todb-r7

This comment has been minimized.

Show comment
Hide comment
@todb-r7

todb-r7 Jul 20, 2015

In the interest of providing an example, I use http://r-7.co/MSF-BUGv1 now. Kinda neat, but I'd rather have the configurable solution.

todb-r7 commented Jul 20, 2015

In the interest of providing an example, I use http://r-7.co/MSF-BUGv1 now. Kinda neat, but I'd rather have the configurable solution.

@marcusgadbem

This comment has been minimized.

Show comment
Hide comment
@marcusgadbem

marcusgadbem Jul 24, 2015

This feature would also be useful in case to pre-fill comment on open issue. Or there is already a way?

marcusgadbem commented Jul 24, 2015

This feature would also be useful in case to pre-fill comment on open issue. Or there is already a way?

@ehausen

This comment has been minimized.

Show comment
Hide comment
@ehausen

ehausen Oct 16, 2015

How to set a label ("bug" for example) for a new issue with URL encoding? Tried a few things, but no luck? Where could I find out parameter names and syntax?

ehausen commented Oct 16, 2015

How to set a label ("bug" for example) for a new issue with URL encoding? Tried a few things, but no luck? Where could I find out parameter names and syntax?

@yfdyh000

This comment has been minimized.

Show comment
Hide comment
@yfdyh000

yfdyh000 Oct 16, 2015

@ehausen I think the reporters don't have necessary permission to applying labels.

yfdyh000 commented Oct 16, 2015

@ehausen I think the reporters don't have necessary permission to applying labels.

@ehausen

This comment has been minimized.

Show comment
Hide comment
@ehausen

ehausen Oct 16, 2015

Yeah the permissions have to be right of course. But this would be for internal use.
https://github.com/organisation/repository-name/issues/new?labels=Bug works!
But I don't know how to get it to assign several labels

ehausen commented Oct 16, 2015

Yeah the permissions have to be right of course. But this would be for internal use.
https://github.com/organisation/repository-name/issues/new?labels=Bug works!
But I don't know how to get it to assign several labels

@thockin

This comment has been minimized.

Show comment
Hide comment
@thockin

thockin Oct 16, 2015

That works IF your users have permissions AND you can control what URL your
users hit. It's not a sufficient solution, though. We need a way to
re-assign the target of the "New Issue" button or to provide per-repo
templates.

On Fri, Oct 16, 2015 at 4:43 AM, Erik Hausen notifications@github.com
wrote:

Yeah the permissions have to be right of course. But this would be for
internal use.
https://github.com/organisation/repository-name/issues/new?labels=Bug
works!
But I don't know how to get it to assign several labels


Reply to this email directly or view it on GitHub
#99 (comment).

thockin commented Oct 16, 2015

That works IF your users have permissions AND you can control what URL your
users hit. It's not a sufficient solution, though. We need a way to
re-assign the target of the "New Issue" button or to provide per-repo
templates.

On Fri, Oct 16, 2015 at 4:43 AM, Erik Hausen notifications@github.com
wrote:

Yeah the permissions have to be right of course. But this would be for
internal use.
https://github.com/organisation/repository-name/issues/new?labels=Bug
works!
But I don't know how to get it to assign several labels


Reply to this email directly or view it on GitHub
#99 (comment).

@modest

This comment has been minimized.

Show comment
Hide comment
@modest

modest Oct 23, 2015

@ehausen In case anyone else stumbles across this... I figured out how to assign multiple labels

&labels[]=FOO&labels[]=BAR

modest commented Oct 23, 2015

@ehausen In case anyone else stumbles across this... I figured out how to assign multiple labels

&labels[]=FOO&labels[]=BAR

@askucher

This comment has been minimized.

Show comment
Hide comment
@askucher

askucher commented Nov 20, 2015

+1

@anewuser

This comment has been minimized.

Show comment
Hide comment
@anewuser

anewuser Nov 20, 2015

@askucher You can follow issues by clicking on the "Subscribe" button on the sidebar. Typing "+1" won't make it become a reality any faster. It just makes all of us receive useless emails and notifications with your "+1".

If you read the frontpage, you'll see that this isn't even an official page (but even if it were, avoid leaving "+1" everywhere):

This is not the actual repository for the GitHub website.

anewuser commented Nov 20, 2015

@askucher You can follow issues by clicking on the "Subscribe" button on the sidebar. Typing "+1" won't make it become a reality any faster. It just makes all of us receive useless emails and notifications with your "+1".

If you read the frontpage, you'll see that this isn't even an official page (but even if it were, avoid leaving "+1" everywhere):

This is not the actual repository for the GitHub website.

@kevinSuttle

This comment has been minimized.

Show comment
Hide comment
@kevinSuttle

kevinSuttle Dec 11, 2015

As of today, the proper URL structure is &labels=.
You can also do &assignee= and &milestone=

kevinSuttle commented Dec 11, 2015

As of today, the proper URL structure is &labels=.
You can also do &assignee= and &milestone=

@cvrebert

This comment has been minimized.

Show comment
Hide comment
@cvrebert

cvrebert Jan 15, 2016

Templates for new issues is one of the features requested in https://github.com/dear-github/dear-github

cvrebert commented Jan 15, 2016

Templates for new issues is one of the features requested in https://github.com/dear-github/dear-github

@todb-r7

This comment has been minimized.

Show comment
Hide comment
@todb-r7

todb-r7 commented Jan 15, 2016

@cvrebert, signed!

@kevinSuttle

This comment has been minimized.

Show comment
Hide comment
@kevinSuttle

kevinSuttle commented Jan 15, 2016

Yep. See also: kevinSuttle/github#32

@sparrc

This comment has been minimized.

Show comment
Hide comment
@sparrc

sparrc Feb 12, 2016

+1, this would be fantastic

sparrc commented Feb 12, 2016

+1, this would be fantastic

@Rican7

This comment has been minimized.

Show comment
Hide comment
@Rican7

Rican7 Feb 17, 2016

Looks like this might actually be happening:
dear-github/dear-github#125

Rican7 commented Feb 17, 2016

Looks like this might actually be happening:
dear-github/dear-github#125

@Whoaa512

This comment has been minimized.

Show comment
Hide comment
@Whoaa512

Whoaa512 Feb 17, 2016

Looks like this now works! Yay 💛

Just add a file called issue_template.md or pull_request_template.md

Whoaa512 commented Feb 17, 2016

Looks like this now works! Yay 💛

Just add a file called issue_template.md or pull_request_template.md

@amerikan

This comment has been minimized.

Show comment
Hide comment
@bigcmos

This comment has been minimized.

Show comment
Hide comment
@bigcmos

bigcmos May 15, 2017

How do you encode a project in the URL? I tried these:
project=
project=MyProject
project[]=MyProject

bigcmos commented May 15, 2017

How do you encode a project in the URL? I tried these:
project=
project=MyProject
project[]=MyProject

@VxJasonxV

This comment has been minimized.

Show comment
Hide comment
@VxJasonxV

VxJasonxV May 17, 2017

It doesn't appear to be possible with the way the project selector is currently implemented.

VxJasonxV commented May 17, 2017

It doesn't appear to be possible with the way the project selector is currently implemented.

yasulab added a commit to coderdojo-japan/dojopaas that referenced this issue Oct 26, 2017

Fix #67: Add FAQs for server problems to README
cf. How to pre-fill information in a new issue
isaacs/github#99
@ento

This comment has been minimized.

Show comment
Hide comment
@ento

ento Nov 9, 2017

The way to assign multiple labels seems to have changed to:

&labels=foo,bar

ento commented Nov 9, 2017

The way to assign multiple labels seems to have changed to:

&labels=foo,bar
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment