refactored .github guidelines

UdacityMobileWebScholarship · Apr 19, 2018 · 76dde67 · 76dde67
1 parent 7175121
commit 76dde67
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 7 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -31,6 +31,16 @@ a proposal for your work first, to be sure that we can use it.
 Before you submit an issue, please search the issue tracker, maybe an issue for your identified problem already exists and you can join the discussion there only.
 For bugs, please try to provide as much information possible to reproduce it as possible, that will really help us a lot!
 
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
 ### <a name="submit-pr"></a> Submitting a Pull Request (PR)
 1. Make sure there is an issue open for the PR and it is assigned to you before starting any work. That way it'll be helpful to eliminate duplicate efforts.
 2. Fork the repo. If already have one, checkout the latest master from upstream.

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,11 +1,23 @@
-**I'm submitting a ...**
-- [ ] bug report
-- [ ] feature request
+# Template to submit an issue
+
+  - [ ] I have read the [contribution guidelines](https://github.com/UdacityMobileWebScholarship/showcase-app/blob/master/.github/CONTRIBUTING.md)
+
+-**I'm submitting a ...**
+<!-- Delete the reasons that don't apply. -->
+
+  - [ ] bug report
+  - [ ] feature request
 
 **Current behavior:**
-<!-- How the bug manifests. -->
+<!-- How the bug manifests.
+  - [ ] `node -v` prints:
+  - [ ] Windows, OS X/macOS, or Linux?: -->
 
 **Expected behavior:**
 <!-- Behavior would be without the bug. -->
 
 **Steps to reproduce:**
+  <!-- Give a complete description of how to reproduce the problem. -->
+
+
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,7 @@
-<!-- Add the issue number that is fixed by this PR (In the form Fixes #123) -->
+<!-- 
+Thanks for contributing to the project. Please follow the guidelines
+below:
+Add the issue number that is fixed by this PR (In the form Fixes #123) -->
 Fixes #
 
 #### Checklist
@@ -9,5 +12,8 @@ Fixes #
 
 #### Changes proposed in this pull request:
 
--
--
+ <!-- Describe how this PR will make our project even more awesome.
+ If this solves an issue, please reference it in this PR. -->
+
+
+