chore(repo): Create issue template #157
Merged
Conversation
This file contains hidden or 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
I made this bespoke, but reviewers please let me know if you're aware of any prior art that you want to just adapt.
tylerbrandt
reviewed
Aug 22, 2018
.github/issue_template.md
Outdated
| @@ -0,0 +1,29 @@ | |||
| Thanks for filing in issue! Are you proposing an enhancement or reporting a bug? | |||
There was a problem hiding this comment.
We should separate instructions from the content we want them to provide (GitHub supports <!-- comments --> for the former; see e.g. https://raw.githubusercontent.com/mishoo/UglifyJS2/master/.github/ISSUE_TEMPLATE.md; that way you don't have to delete a bunch of stuff.).
.github/issue_template.md
Outdated
|
|
||
| Any other relevant tools (like module bundlers, transpilers, etc.): | ||
|
|
||
| ## Expected behavior |
There was a problem hiding this comment.
I like the three-part guide of "What were you trying to do?" (may help resolve X/Y problem issues), "What did you expect to happen?", "What actually happened?" I encountered something like this scheme recently when reporting an issue with npm and it was helpful.
mikeproeng37
approved these changes
Nov 6, 2018
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.
I made this bespoke, but reviewers please let me know if you're aware of any prior art that you want to just adapt.
Is the
Issue = Enhancement | Bugtaxonomy comprehensive (for this SDK, at least)?