Skip to content

Please include a prefilled issue template link #443

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

Closed
sitsofe opened this issue Apr 11, 2015 · 5 comments
Closed

Please include a prefilled issue template link #443

sitsofe opened this issue Apr 11, 2015 · 5 comments

Comments

@sitsofe
Copy link

sitsofe commented Apr 11, 2015

Description of the problem:
Briefly scanning through the recent issues that have been filed in the new Seleinum Github issue tracker shows a pattern of low quality issues which are being posted to the wrong place / lack necessary information. Perhaps a bug template link may raise the bar a little bit?

Steps to reproduce:
Go to https://github.com/SeleniumHQ/selenium/issues?q=is%3Aissue+is%3Aclosed .

Expected results:
Issues that have been filed to contain all the usual information, issues not contain "how do I?" requests.

Actual results:
Many "help me" issues, some issues lacking clear reproduction steps, missing version information etc.

Additional information:
Although it's crude perhaps a link to a prefilled report like
https://github.com/SeleniumHQ/selenium/issues/new?title=footitle&body=barbody
might help a little bit? (found via isaacs/github#99)

Version information:
Github issue tracker as of 11th April 2015.

@lukeis
Copy link
Member

lukeis commented Apr 11, 2015

This is more of a github issue itself by not allowing an issue template akin to google code.

This is not going to stop users from filing poor issues. The type of people who log crappy issue reports completely ignored the predefined template from google code and posted their issues anyways.

Do you have any suggestions where such a link would make sense? (Alas github does not allow us to customize the "new issue" button).

@andreastt
Copy link
Member

However, by having CONTRIBUTING.md in our repository Github puts a link to it at the top when creating an issue or a pull request. @sitsofe, do you think there are things we're missing in that document?

@sitsofe
Copy link
Author

sitsofe commented Apr 12, 2015

@lukeis:
If people willfully overrode the template on Google Code without good reason then I guess there's little hope here.

It's a shame that the "file new issue" link can't be customised. For now I think the only places a bug template link can go is into CONTRIBUTING.md and/or as a new heading in README.md.

@andreastt:
The only real comment I can make is that the document is so big that I can't even see to the end of the table of contents in my (laptop) browser window without scrolling. That document is invaluable for people making code contributions but I'm guessing many users are only going to be filing bugs and won't make it to the "Issue Contributions" ("is that to do with bug reports?") and even then you're still a link away from bug filing basics.

andreastt added a commit that referenced this issue Apr 13, 2015
In #443 there is complains that the ToC makes the page harder to read.
I tend to agree as on a small screen I can't see anything but the ToC.
@andreastt
Copy link
Member

@sitsofe: I've made a series of changes in d23f680..2beb20a that addresses some of your concerns. If you have further concrete ideas, I'm happy to listen to those.

@lukeis
Copy link
Member

lukeis commented Apr 13, 2015

I've also reached out to github support to request that they allow the 'New Issue' button to be customized, or provide an issue template in some manner.

Response I've gotten:
"I'd be happy to pass your feedback to the team to consider, but can't make any promises." :)

@lock lock bot locked and limited conversation to collaborators Aug 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants