Flesh out the issue template to be much more detailed #4849

Merged
merged 2 commits into from May 12, 2016

Conversation

Projects
None yet
4 participants
@envygeeks
Contributor

envygeeks commented Apr 27, 2016

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.

Make the issue template more robust.
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.
@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Apr 27, 2016

Contributor

An example of the final result can be seen here: https://github.com/envygeeks/jekyll/issues/1

Contributor

envygeeks commented Apr 27, 2016

An example of the final result can be seen here: https://github.com/envygeeks/jekyll/issues/1

.github/ISSUE_TEMPLATE.md
+- [ ] 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

This comment has been minimized.

@parkr

parkr Apr 27, 2016

Member

This should be I read the contributing documentation at https://jekyllrb.com/docs/contributing/, right?

@parkr

parkr Apr 27, 2016

Member

This should be I read the contributing documentation at https://jekyllrb.com/docs/contributing/, right?

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Apr 27, 2016

Member

I like this! I think we should add back the section about what they expected to get. Maybe The Output I Wanted.

Member

parkr commented Apr 27, 2016

I like this! I think we should add back the section about what they expected to get. Maybe The Output I Wanted.

@parkr parkr added the meta label Apr 27, 2016

.github/ISSUE_TEMPLATE.md
+- [ ] I am on ***Fedora*** GNU/Linux
+- [ ] I am on ***Arch*** GNU/Linux
+- [ ] I am on ***Other*** GNU/Linux
+- [ ] I am on ***Windows*** 10+

This comment has been minimized.

@DirtyF

DirtyF Apr 28, 2016

Member

Why only Windows 10+? Because of upcoming bash support?

@DirtyF

DirtyF Apr 28, 2016

Member

Why only Windows 10+? Because of upcoming bash support?

This comment has been minimized.

@envygeeks

envygeeks Apr 28, 2016

Contributor

@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.

@envygeeks

envygeeks Apr 28, 2016

Contributor

@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.

Update the ISSUE_TEMPLATE.md file.
* 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.
@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Apr 29, 2016

Contributor

Ping: @parkr @benbalter @alfredxing @jekyll/documentation @jekyll/ecosystem
This pull is completed, you can see an example: https://github.com/envygeeks/jekyll/issues/1
Please review for merge.

Contributor

envygeeks commented Apr 29, 2016

Ping: @parkr @benbalter @alfredxing @jekyll/documentation @jekyll/ecosystem
This pull is completed, you can see an example: https://github.com/envygeeks/jekyll/issues/1
Please review for merge.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Apr 29, 2016

Member

@envygeeks No where in the example does it explain the bug. It just has "What I Wanted," not "What I Got Instead"

Member

parkr commented Apr 29, 2016

@envygeeks No where in the example does it explain the bug. It just has "What I Wanted," not "What I Got Instead"

@parkr parkr changed the title from Make the issue template more robust. to Flesh out the issue template to be much more detailed May 12, 2016

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr May 12, 2016

Member

A little concerned this will be too much and folks won't read it but let's give it a shot.

@jekyllbot: merge +dev

Member

parkr commented May 12, 2016

A little concerned this will be too much and folks won't read it but let's give it a shot.

@jekyllbot: merge +dev

@jekyllbot jekyllbot merged commit 8c9492d into jekyll:master May 12, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

jekyllbot added a commit that referenced this pull request May 12, 2016

@parkr parkr removed the fix label May 12, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment