Add PULL_REQUEST_TEMPLATE

moroshko · Aug 28, 2016 · b5d51bd · b5d51bd
1 parent f7ddbb9
commit b5d51bd
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 9 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,7 +1,9 @@
-# Contributing to react-autosuggest
+Before submitting a Pull Request, please open an issue to discuss the proposed change.
+
+Once you know that your change is aligned with `react-autosuggest` vision:
 
 1. Add your goodness
 2. Add tests
 3. Update docs to reflect changes
 4. Make sure that `npm run build` is happy
-6. Submit a Pull Request (with a detailed description please)
+5. Submit a Pull Request (with a detailed description please)
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,9 +1,8 @@
 ## Are you reporting a bug?
 
-1. Please create a Codepen that demonstrates your issue. You can start from this [Basic example](http://codepen.io/moroshko/pen/LGNJMy).
-
-2. Provide the steps to reproduce the issue, e.g.:
+* Please create a Codepen that demonstrates your issue. You can start from the [Basic example](http://codepen.io/moroshko/pen/LGNJMy).
 
+* Provide the steps to reproduce the issue, e.g.:
   1. Focus on the input field
   2. Type `c`, and wait for suggestions to appear
   3. Press <kbd>Escape</kbd>
@@ -14,10 +13,10 @@
 
 ## Are you making a feature request?
 
-1. Please describe your use case from user journey point of view, e.g.:
+* Please describe your use case from user journey point of view, e.g.:
 
-  > In my application, when user highlights suggestions (using the mouse or keyboard), I'd like to display additional information about the highlighted suggestion alongside with the Autosuggest.
+  > In my application, when user highlights suggestions (using the mouse or keyboard), I'd like to display additional information about the highlighted suggestion alongside the Autosuggest.
 
-2. If you have ideas how to extend the Autosuggest API to support your new feature, please share!
+* If you have ideas how to extend the Autosuggest API to support your new feature, please share!
 
-3. If you know any examples online that already implement such functionality, please provide a link.
+* If you know any examples online that already implement such functionality, please share a link.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,6 @@
+Thanks a lot for contributing to react-autosuggest :beers:
+
+Before submitting the Pull Request, please:
+
+* write a clear description of what this Pull Request is trying to achieve
+* `npm run build` to see that you didn't break anything