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

Documentation: ISSUE_TEMPLATE.md #175

Open
scrabill opened this Issue Oct 3, 2018 · 3 comments

Comments

Projects
None yet
3 participants
@scrabill
Owner

scrabill commented Oct 3, 2018

The purpose of an issue template is to guide Githubbers in providing detailed information when creating a new issue.

The main information I would like this issue template to include is as follows

  • Description of the feature, request or problem. Be specific. If it is a bug, what happened? What were you expecting to happen? If you are looking to make an improvement, outline what you are suggesting and how it might be achieved. You do not know how exactly to solve a problem or how to implement a new feature, but an idea can help to get the information started.

Here is an example of an issue template
https://github.com/thepracticaldev/dev.to/blob/master/.github/ISSUE_TEMPLATE.md

Ours does not need to be that detailed but think about what information you would like to know as a maintainer or would be helpful for contributors to know.

@tonytheleg

This comment has been minimized.

Show comment
Hide comment
@tonytheleg

tonytheleg Oct 4, 2018

Contributor

Hello, are you basically just looking for a markdown file with instructions on what to include for submitting bugs essentially? I think I can manage that!

Contributor

tonytheleg commented Oct 4, 2018

Hello, are you basically just looking for a markdown file with instructions on what to include for submitting bugs essentially? I think I can manage that!

@naufaldi

This comment has been minimized.

Show comment
Hide comment
@naufaldi

naufaldi Oct 4, 2018

hello, i will try to provide making template for issue template. May be try about feature and problem template.

naufaldi commented Oct 4, 2018

hello, i will try to provide making template for issue template. May be try about feature and problem template.

@scrabill

This comment has been minimized.

Show comment
Hide comment
@scrabill

scrabill Oct 6, 2018

Owner

Hi @naufaldi. Tony has just created this (I'm going in order, oldest to newest) but if you have any improvements, go ahead and add them.

Owner

scrabill commented Oct 6, 2018

Hi @naufaldi. Tony has just created this (I'm going in order, oldest to newest) but if you have any improvements, go ahead and add them.

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