Merge pull request #2553 from request/issue-template

add ISSUE_TEMPLATE, move PR template
request · Feb 20, 2017 · da077f7 · da077f7
2 parents fec1f2b + 921ebee
commit da077f7
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,56 @@
+<!---
+BEFORE YOU SUBMIT please read the following:
+
+Please search open/closed issues before submitting since someone might have asked the same thing before!
+
+If you have a support request or question please submit them to one of this resources:
+
+* Stack Overflow: http://stackoverflow.com/questions/tagged/request+node.js using the tags `node.js` & `request`
+* Gitter community: https://gitter.im/request/request?utm_source=newissue
+* Also have a look at the Readme for more information on how to get support:
+  https://github.com/request/request/blob/master/README.md
+
+Issues on GitHub are only related to problems of request itself and we cannot answer
+support questions here.
+-->
+
+### Summary
+<!--- Provide a general summary of the issue in the title above -->
+
+### Simplest Example to Reproduce
+<!--- If describing a bug, tell us what request options we can use to reproduce the same bug/behavior -->
+
+```js
+request({
+  method: 'GET',
+  url: 'http://example.com', // a public URL that we can hit to reproduce, if possible
+  more: { 'options': 'here' }
+},
+```
+
+### Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+<!--- If request is handling requests/responses incorrectly, please include a link to the spec or documentation that supports that your expected behavior is correct. -->
+
+### Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+### Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+### Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+### Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+
+| software         | version
+| ---------------- | -------
+| request          |
+| node             |
+| npm              |
+| Operating System |
diff --git a/PULL_REQUEST_TEMPLATE.md → .github/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md → .github/PULL_REQUEST_TEMPLATE.md
@@ -3,10 +3,10 @@
 - [ ] I have added/updated tests for any new behavior.
        <!-- Request is a complex project, there are VERY FEW exceptions
                where a new test is not required for new behavior. -->
-- [ ] An issue has already been created where the problem / solution was discussed: [N/A, or add link to issue here]
+- [ ] If this is a significant change, an issue has already been created where the problem / solution was discussed: [N/A, or add link to issue here]
        <!-- If you'd like to suggest a significant change to request,
-               please create an issue to discuss those changes
-               BEFORE submitting your PR. -->
+               please create an issue to discuss those changes and gather
+               feedback BEFORE submitting your PR. -->
 
 
 ## PR Description