Flesh out the issue template to be much more detailed #4849
Conversation
This makes the issue template more robust, making check boxes so users can submit and check or check as they go. It also starts using HTML comments so that directions for the users aren't always displayed to us (gotta love Markdown.) And provides the users with more hints on what we would like from them when filing a ticket.
|
An example of the final result can be seen here: https://github.com/envygeeks/jekyll/issues/1 |
|
|
||
| - [ ] I believe this to be a bug, not a question about using Jekyll. | ||
| - [ ] I Read the CONTRIBUTION file at https://github.com/jekyll/jekyll/blob/master/.github/CONTRIBUTING.markdown |
There was a problem hiding this comment.
This should be I read the contributing documentation at https://jekyllrb.com/docs/contributing/, right?
|
I like this! I think we should add back the section about what they expected to get. Maybe |
| - [ ] I am on ***Fedora*** GNU/Linux | ||
| - [ ] I am on ***Arch*** GNU/Linux | ||
| - [ ] I am on ***Other*** GNU/Linux | ||
| - [ ] I am on ***Windows*** 10+ |
There was a problem hiding this comment.
Why only Windows 10+? Because of upcoming bash support?
There was a problem hiding this comment.
@DirtyF Because Ruby already has shoddy Windows support, the last thing I want to do is exacerbate our support for it by supporting what we already have iffy support for by supporting a larger array of Windows versions.
* Link to jekyllrb.com as @parkr suggested. * Add a few more directions and hints for Github Pages users who have errors. * Add words that were missing and made stuff make no sense.
|
Ping: @parkr @benbalter @alfredxing @jekyll/documentation @jekyll/ecosystem |
|
@envygeeks No where in the example does it explain the bug. It just has "What I Wanted," not "What I Got Instead" |
parkr
changed the title
|
A little concerned this will be too much and folks won't read it but let's give it a shot. @jekyllbot: merge +dev |
This makes the issue template more robust, making check boxes so users can submit and check or check as they go. It also starts using HTML comments so that directions for the users aren't always displayed to us (gotta love Markdown.) And provides the users with more hints on what we would like from them when filing a ticket.