New ISSUE_TEMPLATE.md file #1637 #1638
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ntwb
requested changes
Jul 2, 2017
| @@ -0,0 +1,29 @@ | |||
| ## Issue Overview | |||
There was a problem hiding this comment.
Probably above this should be a link to CONTRIBUTING.md
.github/ISSUE_TEMPLATE.md
Outdated
| <!-- Not obligatory, but suggest a fix/reason for the bug, --> | ||
| <!-- or ideas how to implement the addition or change --> | ||
|
|
||
| ## Steps to Reproduce (for bugs) |
There was a problem hiding this comment.
I'd reorder this, the sections should be in the order of:
## Steps to Reproduce (for bugs)
## Expected Behavior
## Current Behavior
It allows the issue reader to gain an overview of the events that led up to the "current behaviour" they see
There was a problem hiding this comment.
That makes sense to me!
|
Should we add a comment asking to look for duplicates before opening an issue? |
|
@youknowriad yes, that's definitely a good idea. I'll add that text. |
…vide instructions prior to submitting issue
swissspidy
reviewed
Jul 4, 2017
| - If you're requesting a new feature, explain why you'd like it to be added. | ||
| - Search this repository for the issue and whether it has been fixed or reported already. | ||
| - Ensure you are using the latest code before logging bugs. | ||
| - Disabled all plugins to ensure it's not a plugin conflict issue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Overview
Added an
ISSUE_TEMPLATE.mdfile as a baseline. This is the one we use in our projects and it has been working pretty nicely for us.If you have any suggested edits, just let me know!
Ref: #1637